Skip to content

Commit

Permalink
Merge pull request #4 from Sydney-Informatics-Hub/docs
Browse files Browse the repository at this point in the history
Add doc guidelines to README
  • Loading branch information
georgiesamaha authored Dec 18, 2023
2 parents d25af0f + 0302607 commit b791bec
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 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 template is under development, with further features and improved documentation to be added.
This is a Nextflow workflow template generator.

## **Why use this template?**

Expand Down Expand Up @@ -51,12 +51,16 @@ git clone https://github.com/georgiesamaha/myWorkflow-nf.git

### [User guide](https://sydney-informatics-hub.github.io/Nextflow_DSL2_template_guide/)

Please see our [documentation](https://sydney-informatics-hub.github.io/Nextflow_DSL2_template_guide/) for instructions on how to use the template code base to build your workflow.
Please see our [documentation](https://sydney-informatics-hub.github.io/Nextflow_DSL2_template_guide/) for instructions on how to use the template code base to build your workflow.

### Install Nextflow

Depending on the system you're working on there are a few options for installing and running Nextflow including software management tools like bioconda and Singularity. See [here](https://www.nextflow.io/docs/latest/getstarted.html#installation) for installation instructions. Once you have installed Nextflow, you can configure it to run on your system if needed.

## **Additional resources**

* [Workflow documentation guidelines](https://github.com/AustralianBioCommons/doc_guidelines)

## **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.

0 comments on commit b791bec

Please sign in to comment.