Skip to content

Commit

Permalink
Add tree diagram to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
georgiesamaha authored Jul 10, 2024
1 parent b791bec commit 1e83d87
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,33 @@ 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
├── bin
   └── samplesheetchecker.py
├── config
├── gadi.config
   ├── nimbus.config
   ├── setonix.config
   └── standard.config
├── modules
| ├── check_input.nf
│   ├── process1.nf
│   └── process2.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?**

Once you create a new repository using this template, a GitHub Action workflow will automatically be deployed. This workflow will populate your new repository with the skeleton template directory. To create a new repository:
Expand Down Expand Up @@ -63,4 +90,4 @@ Depending on the system you're working on there are a few options for installing

## **Acknowledgements**

The work presented here was developed by the Sydney Informatics Hub, a Core Research Facility of the University of Sydney and the Australian BioCommons 'Bring Your Own Data' Platforms Project which is enabled by NCRIS via ARDC and Bioplatforms Australia.
The work presented here was developed by the Sydney Informatics Hub, a Core Research Facility of the University of Sydney and the Australian BioCommons 'Bring Your Own Data' Platforms Project which is enabled by NCRIS via ARDC and Bioplatforms Australia.

0 comments on commit 1e83d87

Please sign in to comment.