feat: install instructions

This commit is contained in:
orangerot 2025-09-11 21:04:06 +02:00
parent dc49755cb6
commit a9551946ea
2 changed files with 29 additions and 0 deletions

View file

@ -5,6 +5,11 @@
TEMPLATES = muendliche-pruefung muendliche-nachpruefung muendliche-pruefung-mathematik
FILES = README.md main.typ lib.typ $1.typ $1.pdf
PACKAGE_NAME = fsmi-exam-report
PACKAGE_VERSION = 0.1.0
PREFIX ?= $(HOME)/.local/share/typst/packages/local
INSTALLDIR = $(PREFIX)/$(PACKAGE_NAME)/$(PACKAGE_VERSION)
dist: $(addsuffix .tar.gz,${TEMPLATES})
mkdir -p dist
mv $^ dist
@ -19,3 +24,12 @@ endef
$(foreach template,${TEMPLATES},$(eval $(call make-archive,${template})))
.PHONY: install
install:
mkdir -p ${INSTALLDIR}
cp -r * ${INSTALLDIR}
.PHONY: uninstall
uninstall:
rm -rf ${INSTALLDIR}

View file

@ -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.