feat(prufung): README

mundl-prufung/README.md

@@ -0,0 +1,87 @@
+# Vorlagen mündliche Prüfung (Bachelor, Master, Diplom) 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.
+
+Zum Erstellen des Dokumentes müssen lediglich die Argumente in der Datei
+`nachprufung.typ` ausgefüllt werden.
+
+```typst
+#import "lib.typ": prufung, kind
+
+#show: prufung.with(
+  study: "",                                 // Studiengang
+  lecture: "",                               // Fach
+  kind: kind.none,                           // Prüfungsart (Wahlpflicht, Vertiefungsfach, Ergänzungsfach)
+  date: datetime(year: 0, month: 1, day: 1), // Prüfungsdatum
+  examiner: "",                              // PrüferIn (Prof)
+  assistant: "",                             // BeisitzerIn
+  grade_received: 0.0,                       // Note
+  grade_reasonable: "",                      // War die Note angemessen?
+  exam_duration: duration(minutes: 0),       // Prüfungsdauer
+  attendance: (
+  /* Veranstaltung, Dozent(in), Jahr, regelmäßig besucht? */
+    (lecture: "", lecturer: "", year: "", did_attend: ""),
+    (lecture: "", lecturer: "", year: "", did_attend: ""),
+    (lecture: "", lecturer: "", year: "", did_attend: ""),
+    (lecture: "", lecturer: "", year: "", did_attend: ""),
+  ),
+  attendance_worth: [
+    // Hat sich der Besuch / Nichtbesuch der Veranstaltung für dich gelohnt?
+  ],
+  preparation_time: [
+    // Wie lange und wie hast alleine bzw. mit anderen vorbereitet?
+  ],
+  agreements: [
+    // Fanden vor der Prüfung Absprachen zu Form oder Inhalt statt? Wurden sie eingehalten?
+  ],
+  preparations: [
+    // Welche Tips zur Vorbereitung kannst Du geben?
+  ],
+  examiner_behavior: [
+    // Wie war der Prüfungsstil des Prüfers / der Prüferin?
+  ],
+  examiner_recommendation: (none, [          // true, false
+    // Kannst du ihn / sie weiterempfehlen? Warum?
+  ]),
+  examinee_behavior: [
+    // Kannst Du Ratschläge Verhalten in der Prüfung geben?
+  ],
+)
+
+// Schreibe bitte möglichst viele Fragen und Antworten auf.
+// Hier ist Platz für deinen Kommentar
+```
+
+Um den Fragebogen schlussendlich zu bauen führt man folgenden Befehl aus:
+```sh
+typst compile prufung.typ
+```
+
+Um die Änderungen direkt beim Speichern zu sehen, kann man folgenden Befehl
+nutzen:
+```sh
+typst watch prufung.typ
+```
+
+## Hintergrund
+
+Diese Vorlage ist stark Inspiriert von der [Protokollvorlage mündliche Prüfung
+(TeX)](https://legacy.fsmi.org/Pruefungen/Vorlagen/Info/muendlich-neu.tar.gz)
+von der Liste an [Protokollvorlagen](https://www.fsmi.org/studium/pruefungen/muendliche-pruefungen/#protokoll-vorlagen)
+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.
+