feat: README

1 files changed, 44 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..98c27d0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# Vorlage mündliche Nachprüfung (3. Versuch) 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.
+
+Für Informationen zu dem Textsatzsystem Typst am besten in die [Dokumentation](https://typst.app/docs/)
+schauen.
+
+## 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
+```
+
+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.
+
+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.
+
+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.
+