summaryrefslogtreecommitdiff
path: root/muendliche-pruefung
diff options
context:
space:
mode:
authororangerot <orangerot@orangerot.dev>2025-09-09 11:32:49 +0200
committerorangerot <orangerot@orangerot.dev>2025-09-09 11:32:49 +0200
commitc6e566775daa8c77b1a9108ef2bfd1d9c1146b9d (patch)
treee4d465f699ff166a3d9d97888e8bd2a77d308f72 /muendliche-pruefung
parentd9a420ed315d753a9bc84532ce867690a8c5daeb (diff)
doc: update usage in READMEs with new file names and arguments
Diffstat (limited to 'muendliche-pruefung')
-rw-r--r--muendliche-pruefung/README.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/muendliche-pruefung/README.md b/muendliche-pruefung/README.md
index 6fb0f55..923700a 100644
--- a/muendliche-pruefung/README.md
+++ b/muendliche-pruefung/README.md
@@ -13,15 +13,15 @@ Es ist der Typst-Compiler nötig. Dieser ist für eine vielzahl an Betriebssyste
verfügbar.
Zum Erstellen des Dokumentes müssen lediglich die Argumente in der Datei
-`muendliche-pruefung.typ` ausgefüllt werden.
+`main.typ` ausgefüllt werden.
```typst
-#import "lib.typ": oral-exam, kind
+#import "lib.typ": oral-exam, KIND
#show: oral-exam.with(
study: "", // Studiengang
lecture: "", // Fach
- kind: kind.none, // Prüfungsart (Wahlpflicht, Vertiefungsfach, Ergänzungsfach)
+ kind: KIND.NONE, // Prüfungsart KIND.{WAHLPFLICHT, VERTIEFUNGSFACH, ERGUENZUNGSFACH}
date: datetime(year: 0, month: 1, day: 1), // Prüfungsdatum
examiner: "", // PrüferIn (Prof)
assistant: "", // BeisitzerIn
@@ -64,9 +64,14 @@ Zum Erstellen des Dokumentes müssen lediglich die Argumente in der Datei
Um den Fragebogen schlussendlich zu bauen führt man folgenden Befehl aus:
```sh
-typst compile muendliche-pruefung.typ
+typst compile main.typ
```
+Für Personen, welche in die Struktur des Dokuments eintauchen wollen gibt es die
+Datei `muendliche-pruefung.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