Update README

jansim · Jul 17, 2024 · 1d53822 · 1d53822
1 parent 50e8faf
commit 1d53822
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -1,45 +1,58 @@
-Introduction to `git`
-================
+# Introduction to `git`
 Jan Simson
 
 This repository contains the course materials for a one-day workshop
 titled “Data Literacy: Introduction to `git`” which I gave at the
 Karlsruhe Institute for Technology (KIT).
 
+<!--
+ To update the README, render this file directly via
+ quarto render README.qmd --to=gfm
+-->
+
 ## Contents
 
 ### Slides
 
 - Block 1: Introduction & Basics
- - 1.0 Intro [\[slides\]](output/1.0-intro.html)
- - 1.1 What is git? [\[slides\]](output/1.1-what_is_git.html)
- - 1.2 Tracking Changes [\[slides\]](output/1.2-tracking_changes.html)
+ - 1.0 Intro
+ [\[slides\]](https://simson.io/intro-to-git/1.0-intro.html)
+ - 1.1 What is git?
+ [\[slides\]](https://simson.io/intro-to-git/1.1-what_is_git.html)
+ - 1.2 Tracking Changes
+ [\[slides\]](https://simson.io/intro-to-git/1.2-tracking_changes.html)
 - Block 2: Branches & More
- - 2.1 .gitignore [\[slides\]](output/2.1-gitignore.html)
- - 2.2 History [\[slides\]](output/2.2-history.html)
+ - 2.1 .gitignore
+ [\[slides\]](https://simson.io/intro-to-git/2.1-gitignore.html)
+ - 2.2 History
+ [\[slides\]](https://simson.io/intro-to-git/2.2-history.html)
  - 2.3 Branches & Merging
- [\[slides\]](output/2.3-branches_merging.html)
+ [\[slides\]](https://simson.io/intro-to-git/2.3-branches_merging.html)
 - Block 3: Collaboration via Github
- - 3.1 What is GitHub? [\[slides\]](output/3.1-what_is_github.html)
- - 3.2 Synching Changes [\[slides\]](output/3.2-synching_changes.html)
+ - 3.1 What is GitHub?
+ [\[slides\]](https://simson.io/intro-to-git/3.1-what_is_github.html)
+ - 3.2 Synching Changes
+ [\[slides\]](https://simson.io/intro-to-git/3.2-synching_changes.html)
  - 3.3 Markdown & GitHub Pages
- [\[slides\]](output/3.3-pages_markdown.html)
+ [\[slides\]](https://simson.io/intro-to-git/3.3-pages_markdown.html)
 - Block 4: Advanced Github & Beyond
- - 4.1 Advanced GitHub [\[slides\]](output/4.1-advanced_github.html)
- - 4.2 Final Notes [\[slides\]](output/4.2-final_notes.html)
+ - 4.1 Advanced GitHub
+ [\[slides\]](https://simson.io/intro-to-git/4.1-advanced_github.html)
+ - 4.2 Final Notes
+ [\[slides\]](https://simson.io/intro-to-git/4.2-final_notes.html)
  - *Outro*
 
 <!-- *: Since they have to be manually generated, the PDF version of slides may be slightly outdated. Please refer to [this guide](https://revealjs.com/pdf-export/), on how to export your own PDF version from the online slides. -->
 
 ### Supporting Documents
 
 - Supplementary [student information
- sheet](output/resources/student-info/student-info.pdf)
+ sheet](https://simson.io/intro-to-git/resources/student-info/student-info.pdf)
 - How to Setup SSH authentication for GitHub
- [\[PDF\]](output/resources/ssh/how-to-setup-github-ssh.pdf)
- [\[HTML\]](https://malikaihle.github.io/Introduction-RStudio-Git-GitHub/SSH.html)
+ [\[PDF\]](https://simson.io/intro-to-git/resources/ssh/how-to-setup-github-ssh.pdf)
+ [\[HTML\]](https://lmu-osc.github.io/Introduction-RStudio-Git-GitHub/SSH.html)
  - By [Mike Croucher & Malika
- Ihle](https://github.com/MalikaIhle/Introduction-RStudio-Git-GitHub)
+ Ihle](https://github.com/lmu-osc/Introduction-RStudio-Git-GitHub)
 - Git Cheatsheet [\[PDF\]](resources/git-cheat-sheet-education.pdf)
  - By [GitHub Education](https://education.github.com/)
 
@@ -57,7 +70,7 @@ Karlsruhe Institute for Technology (KIT).
  - <https://gitimmersion.com>
  - <https://github.com/git-guides>
  - [Introduction to RStudio Git &
- GitHub](https://malikaihle.github.io/Introduction-RStudio-Git-GitHub/)
+ GitHub](https://lmu-osc.github.io/Introduction-RStudio-Git-GitHub/)
  - [The Carpentries: Version Control with
  Git](https://swcarpentry.github.io/git-novice/)
 - Further reading (beyond the contents of the course)
@@ -73,6 +86,7 @@ Karlsruhe Institute for Technology (KIT).
  [(🇩🇪)](https://ohshitgit.com/de)
  - Google: Just googling your problem is often the most useful
  solution
+- Follow up course: <http://simson.io/advanced-git/>
 
 ## License
 

diff --git a/README.qmd b/README.qmd
@@ -10,40 +10,46 @@ format:
  gfm:
  toc: false
  output-file: README.md
+format-links: []
 ---
 
 This repository contains the course materials for a one-day workshop titled "Data Literacy: Introduction to `git`" which I gave at the Karlsruhe Institute for Technology (KIT).
 
+<!--
+ To update the README, render this file directly via
+ quarto render README.qmd --to=gfm
+-->
+
 ## Contents
 
 ### Slides
 
 - Block 1: Introduction & Basics
- - 1.0 Intro [[slides]](output/1.0-intro.html)
- - 1.1 What is git? [[slides]](output/1.1-what_is_git.html)
- - 1.2 Tracking Changes [[slides]](output/1.2-tracking_changes.html)
+ - 1.0 Intro [[slides]](https://simson.io/intro-to-git/1.0-intro.html)
+ - 1.1 What is git? [[slides]](https://simson.io/intro-to-git/1.1-what_is_git.html)
+ - 1.2 Tracking Changes [[slides]](https://simson.io/intro-to-git/1.2-tracking_changes.html)
 
 - Block 2: Branches & More
- - 2.1 .gitignore [[slides]](output/2.1-gitignore.html)
- - 2.2 History [[slides]](output/2.2-history.html)
- - 2.3 Branches & Merging [[slides]](output/2.3-branches_merging.html)
+ - 2.1 .gitignore [[slides]](https://simson.io/intro-to-git/2.1-gitignore.html)
+ - 2.2 History [[slides]](https://simson.io/intro-to-git/2.2-history.html)
+ - 2.3 Branches & Merging [[slides]](https://simson.io/intro-to-git/2.3-branches_merging.html)
 
 - Block 3: Collaboration via Github
- - 3.1 What is GitHub? [[slides]](output/3.1-what_is_github.html)
- - 3.2 Synching Changes [[slides]](output/3.2-synching_changes.html)
- - 3.3 Markdown & GitHub Pages [[slides]](output/3.3-pages_markdown.html)
+ - 3.1 What is GitHub? [[slides]](https://simson.io/intro-to-git/3.1-what_is_github.html)
+ - 3.2 Synching Changes [[slides]](https://simson.io/intro-to-git/3.2-synching_changes.html)
+ - 3.3 Markdown & GitHub Pages [[slides]](https://simson.io/intro-to-git/3.3-pages_markdown.html)
 
 - Block 4: Advanced Github & Beyond
- - 4.1 Advanced GitHub [[slides]](output/4.1-advanced_github.html)
- - 4.2 Final Notes [[slides]](output/4.2-final_notes.html)
+ - 4.1 Advanced GitHub [[slides]](https://simson.io/intro-to-git/4.1-advanced_github.html)
+ - 4.2 Final Notes [[slides]](https://simson.io/intro-to-git/4.2-final_notes.html)
  - *Outro*
 
 <!-- *: Since they have to be manually generated, the PDF version of slides may be slightly outdated. Please refer to [this guide](https://revealjs.com/pdf-export/), on how to export your own PDF version from the online slides. -->
 
 ### Supporting Documents
 
-- Supplementary [student information sheet](output/resources/student-info/student-info.pdf)
-- How to Setup SSH authentication for GitHub [[PDF]](output/resources/ssh/how-to-setup-github-ssh.pdf) [[HTML]](https://lmu-osc.github.io/Introduction-RStudio-Git-GitHub/SSH.html)
+- Supplementary [student information sheet](https://simson.io/intro-to-git/resources/student-info/student-info.pdf)
+- How to Setup SSH authentication for GitHub [[PDF]](https://simson.io/intro-to-git/resources/ssh/how-to-setup-github-ssh.pdf) [[HTML]](https://lmu-osc.github.io/Introduction-RStudio-Git-GitHub/SSH.html)
  - By [Mike Croucher & Malika Ihle](https://github.com/lmu-osc/Introduction-RStudio-Git-GitHub)
 - Git Cheatsheet [[PDF]](resources/git-cheat-sheet-education.pdf)
  - By [GitHub Education](https://education.github.com/)
@@ -68,6 +74,7 @@ This repository contains the course materials for a one-day workshop titled "Dat
  - If you have a problem
  - [ohshitgit.com](https://ohshitgit.com/) [(🇩🇪)](https://ohshitgit.com/de)
  - Google: Just googling your problem is often the most useful solution
+- Follow up course: <http://simson.io/advanced-git/>
 
 ## License