A README.md
file is a very useful component of any project repository. As you can see, it is automatically rendered on GitHub, where it acts as a simple "homepage" for your project.
The purpose of this repository is to distribute handouts during a SESYNC training event. The content changes between short courses, but it typically includes the worksheets for severl lessons. Most trainees will import this repository during a short course. Instructions for creating your own GitHub repository will be given during the course and are also described in CONTRIBUTING.md.
If the repository does not contain a data folder, download a zipped data file to accompany the worksheets. A "good" data-synthesis pipeline separates the data from source code with separate storage locations—we'll take a shortcut for these lessons.
Following a short course, the worksheets and data will be archived as a zip file. To get the handouts from a past short course: navigate to releases, select your course by its starting date, and download Source code (zip)
and data.zip
. The downloads do not contain a git repository—only the worksheets and necessary data.