X-Git-Url: https://git.arvados.org/rnaseq-cwl-training.git/blobdiff_plain/1ead988de359a7ffb155615473fd03f5ab9c735d..HEAD:/README.md diff --git a/README.md b/README.md index fd9a630..6eb3a0c 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,40 @@ +# Getting started with CWL -# Downloading reference data +This training will walk you through the development of a +best-practices CWL workflow. At the conclusion of this training, you +should have a grasp of the essential components of a workflow, and +have a basis for learning more. -``` -mkdir rnaseq -cd rnaseq -wget --mirror --no-parent --no-host --cut-dirs=1 https://download.pirca.arvadosapi.com/c=pirca-4zz18-sa9s62lzc00jeds/ -``` +These lessons are based on [Introduction to RNA-seq using +high-performance computing +(HPC)](https://github.com/hbctraining/Intro-to-rnaseq-hpc-O2) lessons +developed by members of the teaching team at the Harvard Chan +Bioinformatics Core (HBC). The original training, which includes +additional lectures about the biology of RNA-seq, can be found at that +link. -# Building the Docker image -``` -cd dockerfile -docker build -t cwl-training-rnaseq-tools . -``` +## Contributing -# Acknowledgements +We welcome all contributions to improve the lesson! Maintainers will do their best to help you if you have any +questions, concerns, or experience any difficulties along the way. -These CWL lessons are based on "Introduction to RNA-seq using -high-performance computing (HPC)" lessons developed by members of the -teaching team at the Harvard Chan Bioinformatics Core (HBC) and -obtained from +We'd like to ask you to familiarize yourself with our [Contribution Guide](CONTRIBUTING.md) and have a look at +the [more detailed guidelines][lesson-example] on proper formatting, ways to render the lesson locally, and even +how to write new episodes. -https://github.com/hbctraining/Intro-to-rnaseq-hpc-O2 +## Maintainer(s) -The original lessons are open access materials distributed under the -terms of the Creative Commons Attribution license (CC BY 4.0), which -permits unrestricted use, distribution, and reproduction in any -medium, provided the original author and source are credited. +Current maintainers of this lesson are + +* Peter Amstutz + +## Authors + +A list of contributors to the lesson can be found in [AUTHORS](AUTHORS) + +## Citation + +To cite this lesson, please consult with [CITATION](CITATION) + +[lesson-example]: https://carpentries.github.io/lesson-example