From a9551946ea37f6c3cc873385c1a5cba1da159168 Mon Sep 17 00:00:00 2001 From: orangerot Date: Thu, 11 Sep 2025 21:04:06 +0200 Subject: feat: install instructions --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'README.md') 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. -- cgit v1.2.3