X-Git-Url: https://git.arvados.org/rnaseq-cwl-training.git/blobdiff_plain/d177113e4a57ff8fe980212e51fe4317cf0fcb5a..HEAD:/README.md diff --git a/README.md b/README.md index 510d494..6eb3a0c 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,40 @@ -# Lessons +# Getting started with CWL -These lessons go walk through the development of a CWL workflow for -rnaseq. +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. -| Lesson | Description | -|----------|-------------| -| [Lesson 1](lesson1/lesson1.md) | Turning a shell script into a workflow by composing existing tools | -| [Lesson 2](lesson2/lesson2.md) | Running and debugging a workflow | -| [Lesson 3](lesson3/lesson3.md) | Writing a tool wrapper | -| [Lesson 4](lesson4/lesson4.md) | Analyzing multiple samples | -| [Lesson 5](lesson5/lesson5.md) | Dynamic Workflow behavior with expressions | -| [Lesson 6](lesson6/lesson6.md) | Resources for further learning | +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. -# Acknowledgements -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 +## Contributing -https://github.com/hbctraining/Intro-to-rnaseq-hpc-O2 +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. -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. +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. + +## Maintainer(s) + +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