summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authororangerot <orangerot@orangerot.dev>2025-09-11 21:04:06 +0200
committerorangerot <orangerot@orangerot.dev>2025-09-11 21:04:06 +0200
commita9551946ea37f6c3cc873385c1a5cba1da159168 (patch)
treef7f347bc1decaac70da0c1b581d1626868c4ddf0 /README.md
parentdc49755cb6b596dd57ac1bfa9a8d33174d22102f (diff)
feat: install instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 929151c..507aaa1 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,21 @@ In den Unterordern finden sich jeweils die Vorlagen für
Wie die Vorlagen verwendet werden, wird in der `README.md` in den jeweiligen
Unterordern erläutert.
+### Lokale Installation
+
+Sobald man das Paket mit `make install`
+[lokal installiert](https://github.com/typst/packages?tab=readme-ov-file#local-packages)
+, kann man die Vorlage in jedem Ordner verwenden:
+```sh
+typst init @local/fsmi-exam-report:0.1.0
+cd fsmi-exam-report
+```
+
+### Veröffentlichen
+
+Um die einzelnen Vorlagen für die Veröffentlichung zu archivieren, führt man
+`make dist` aus. Die Archive sind dann im `dist/` Ordner zu finden.
+
## Lizenz
Das Projekt steht unter der MIT Lizenz - siehe `LICENSE` Datei für Details.