Remove software carpentries logo
[rnaseq-cwl-training.git] / README.md
index f35a870cde07dbeb02401f33317190384269a35d..6eb3a0cb6100306535d3da27aa87a251782143e6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,14 +1,40 @@
+# Getting started with CWL
 
-# Acknowledgements
+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.
 
-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
+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.
 
-https://github.com/hbctraining/Intro-to-rnaseq-hpc-O2
 
-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.
+## Contributing
+
+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.
+
+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 <peter.amstutz@curii.com>
+
+## 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