Crash course on version control and documentation with GitHub

Training materials and slides for a crash course on version control, clean code and documentation with practical examples and exercises in Python and R.

Creator

These materials were created by the University of Basel’s Research and Infrastructure Support RISE (rise@unibas.ch) in 2024.

File structure

The file structure mirrors the outline of the course:

• slides as Markdown in crash-course-github/slides.md
• slides as HTML in crash-course-github/slides.html
• all images used in crash-course-github/images

Pandoc was used to create HTML slides: pandoc -s --webtex -i -t slidy in_file.md -o out_file.html

Upcoming and past course dates

• 2024-04-19: RISE crash-course “Version Control and Documentation with GitHub”, online

To dos

• Create release for course on April 19, 2024

License

This work is licensed under a Creative Commons Attribution 4.0 International License.