BWINF Markdown Vorlage

Dies ist eine Vorlage für Dokumentiation in Markdown für den Bundeswettbewerb Informatik.

Benutzen

Dieses Kapitel beschreibt nur eine von vielen Möglichkeiten, wie diese Vorlage benutzt werden kann. Es gibt viele Markdown-Editoren, die auch die Möglichkeit bieten, die Markdown-Datei in eine PDF zu kompilieren. Hier wird nur eine Möglichkeit beschrieben.

Die beschriebene Methode hat den Vorteil, dass die Programmiersprache R verwendet wird, um die PDF zu erstellen. Das ermöglicht es, auch Diagramme und Tabellen zu erstellen. Außerdem kann RStudio deine Datei automatisch in eine PDF umwandeln, wenn du auf "Knit" drückst oder die Datei speicherst.

1. Benötigte Software installieren
   1. Installiere R
   2. Installiere RStudio
   3. Installiere ein LaTeX-System, z.B. TeX Live
2. Erstelle ein neues Projekt in RStudio "File" -> "New Project"
3. Erstelle eine neue RMarkdown-Datei "File" -> "New File" -> "R Markdown..."
   1. Die Einstellungen sind egal, da wir die Vorlage sowieso überschreiben
4. Kopiere den Inhalt der Datei main.Rmd in die neu erstellte Datei
5. Kopiere die Datei bwinf.latex in den gleichen Ordner wie die RMarkdown-Datei
6. Drücke auf "Knit" um die PDF zu erstellen.

RStudio hat viele weitere Funktionen, die dir helfen können, deine Dokumentation zu schreiben. Mehr Informationen findest du in der RStudio-Dokumentation.

Credits

Diese Vorlage basiert auf dem Tutorial von Mike Frank & Chris Hartgerink: https://libscie.github.io/rmarkdown-workshop/handout.html