summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authororangerot <orangerot@orangerot.dev>2025-08-31 01:11:19 +0200
committerorangerot <orangerot@orangerot.dev>2025-08-31 01:39:54 +0200
commit9ac7b58b29c67f81279d7039609836da3eb9f30b (patch)
tree3d33e0a84ed8b52c87191bfa1f16ed91c9e67b32 /README.md
parent2c501fd627f7a04e0d328bfa2f177ad5d4b18ba6 (diff)
style: uniform naming convention with directories, files and variables
Diffstat (limited to 'README.md')
-rw-r--r--README.md50
1 files changed, 13 insertions, 37 deletions
diff --git a/README.md b/README.md
index 98c27d0..068de55 100644
--- a/README.md
+++ b/README.md
@@ -1,44 +1,20 @@
-# Vorlage mündliche Nachprüfung (3. Versuch) in Typst
+# Protokoll-Vorlagen in Typst
-Dieser Fragebogen gibt den KommilitonInnen, die nach Dir die Prüfung ablegen
-wollen, einen Einblick in Ablauf und Inhalt der Prüfung. Das erleichtert die
-Vorbereitung.
+Hier finden sich Vorlagen für Prüfungsprotokolle am KIT für die Fachschaft
+Mathematik/Informatik, neu erstellt in dem modernen Textsatzsystem
+[Typst](https://typst.app/)
+und inspiriert von den
+[Vorlagen in LaTeX](https://www.fsmi.org/studium/pruefungen/muendliche-pruefungen/#protokoll-vorlagen).
-Für Informationen zu dem Textsatzsystem Typst am besten in die [Dokumentation](https://typst.app/docs/)
-schauen.
+## Struktur
-## Nutzung
-
-Es ist der Typst-Compiler nötig. Dieser ist für eine vielzahl an Betriebssystemen
-verfügbar.
-
-Die Vorlage enthält zwei Optionen den Fragebogen zu erstellen. Empfohlen ist das
-Erstellen mit Template. Dafür müssen lediglich die Argumente in der Datei
-`nachprufung.typ` ausgefüllt werden. Um den Fragebogen schlussendlich zu bauen
-führt man folgenden Befehl aus:
-```sh
-typst compile nachprufung.typ
-```
+In den Unterordern finden sich jeweils die Vorlagen für
-Für Personen, welche in die Struktur des Dokuments eintauchen wollen gibt es die
-Datei `bachelor.typ`. Diese ist der Inspiration in TeX vom Aufbau ähnlich. Das
-befüllen des Fragebogens ist hier etwas schwerer, weil erst die richtige Stelle
-im Code gefunden werden muss.
+- **Vorlagen mündliche Nachprüfung (3. Versuch)** `muendliche-nachpruefung/`
+- **Vorlagen mündliche Prüfung (Bachelor, Master, Diplom)** `muendliche-pruefung/`
-Um die Änderungen direkt beim Speichern zu sehen, kann man folgenden Befehl
-nutzen:
-```sh
-typst watch nachprufung.typ
-```
-
-## Hintergrund
-
-Diese Vorlage ist stark Inspiriert von der [Protokollvorlage Nachprüfung
-(TeX)](https://legacy.fsmi.org/Pruefungen/Vorlagen/Info/bachelor.tgz) von der
-Liste an [Protokollvorlagen](https://www.fsmi.org/studium/pruefungen/muendliche-pruefungen/) der Fachschaft Mathematik/Informatik des KIT.
+## Nutzung
-Bei der Erstellung der Vorlage wurde darauf geachtet, dass die PDF-Ausgabe von
-Typst möglichst ähnlich zu der PDF-Ausgabe der Inspiration in TeX ist. Dabei
-werden diverse Layoutelemente von Typst verwendet, welche das Layout mit Tabellen in
-TeX ersetzen.
+Wie die Vorlagen verwendet werden, wird in der `README.md` in den jeweiligen
+Unterordern erläutert.