Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
georgiesamaha authored Sep 13, 2024
1 parent d5ed46b commit 18798d5
Showing 1 changed file with 1 addition and 28 deletions.
29 changes: 1 addition & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# template-nf

This is a Nextflow workflow template generator.
This is a Nextflow workflow template generator. See our guide: https://sydney-informatics-hub.github.io/template-nf-guide/.

## **Why use this template?**

Expand All @@ -23,33 +23,6 @@ It is not suitable for:
* Those creating simple or single-task workflows with only a few tasks and minimal complexity.
* Those with no previous command-line and bash experience.

## **How is this template structured?**

The template’s code repository is organised into a number of files and directories (see [documentation](https://sydney-informatics-hub.github.io/Nextflow_DSL2_template_guide/) for details):
```
myWorkflow-nf
├── .github/ISSUE_TEMPLATE
├── assets/
│   └── samplesheet.csv (demo)
├── bin/
│   └── samplesheetchecker.sh (demo)
├── config/
├── gadi.config
   ├── nimbus.config
   ├── setonix.config
   └── standard.config
├── modules
| ├── check_input.nf (demo)
│   ├── generate_report.nf (demo)
│   ├── group_samples.nf (demo)
│   └── template_process.nf
├── .gitignore
├── LICENSE
├── README.md
├── main.nf
└── nextflow.config
```

If you'd like to stickybeak before cloning this repository, you can view the codebase [here](https://github.com/Sydney-Informatics-Hub/Nextflow_DSL2_template/tree/main/%7B%7Bcookiecutter.app_name%7D%7D).

## **How to use the template?**
Expand Down

0 comments on commit 18798d5

Please sign in to comment.