From 0302607f4ffac2cf39145f6e9b39b8b7849a134b Mon Sep 17 00:00:00 2001 From: georgiesamaha Date: Mon, 18 Dec 2023 17:09:17 +1100 Subject: [PATCH] Add doc guidelines to README --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9bf5489..0657bbf 100644 --- a/README.md +++ b/README.md @@ -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?** @@ -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. \ No newline at end of file