add slides for crash course on GitHub and documentation

fix some typos

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- Added [`clean-code/crash-course-github`](https://github.com/RISE-UNIBAS/clean-code/tree/main/crash-course-github) for new RISE crash-course "Version Control and Documentation with GitHub".
+
 ## [0.2.0] - 2024-02-05
 
 ### Added

course/README.md

@@ -13,7 +13,7 @@ The file structure mirrors the outline of the course:
 
 ## Upcoming and past course dates
 
-- 2024-04-10, 2024-04-11 and 2024-04-13: Course "Clean Code, Documentation & Version Control", WWZ / S16 / Peter Merian-Weg 6, Basel, [course details](https://vorlesungsverzeichnis.unibas.ch/en/home?id=283937)
+- 2024-04-10, 2024-04-11 and 2024-04-13: course "Clean Code, Documentation & Version Control", WWZ / S16 / Peter Merian-Weg 6, Basel, [course details](https://vorlesungsverzeichnis.unibas.ch/en/home?id=283937)
 
 ## License
 

course/github/3_best_practices.md

@@ -95,7 +95,6 @@ From [GitHub glossary/GitHub pages](https://docs.github.com/en/get-started/learn
 ### Secrets
 
 - login credentials, API keys...
-- 
 
 ## Collaboration
 

crash-course-github/README.md

@@ -0,0 +1,30 @@
+# 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`](https://github.com/RISE-UNIBAS/clean-code/tree/main/crash-course/git/git.md) 
+- slides as HTML in [`crash-course-github/slides.html`](https://github.com/RISE-UNIBAS/clean-code/tree/main/crash-course/git/git.html)
+- all images used in [`crash-course-github/images`](https://github.com/RISE-UNIBAS/clean-code/tree/main/crash-course/git/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
+
+<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
+

crash-course/README.md

@@ -17,8 +17,8 @@ The file structure mirrors the outline of the course:
 
 ## Upcoming and past course dates
 
-- 2024-02-05: RISE Crash-course "Clean Code, Documentation & Version Control", WWZ / S13 / Peter Merian-Weg 6, Basel
-- 2023-02-17: RISE Crash-course "Clean Code, Documentation & Version Control", WWZ / S14 / Peter Merian-Weg 6, Basel, [course details](https://wwz.unibas.ch/en/event/details/rise-crashcourse-on-clean-code-documentation-version-control/)
+- 2024-02-05: RISE crash-course "Clean Code, Documentation & Version Control", WWZ / S13 / Peter Merian-Weg 6, Basel
+- 2023-02-17: RISE crash-course "Clean Code, Documentation & Version Control", WWZ / S14 / Peter Merian-Weg 6, Basel, [course details](https://wwz.unibas.ch/en/event/details/rise-crashcourse-on-clean-code-documentation-version-control/)
 
 ## To dos