diff --git a/README.md b/README.md new file mode 100644 index 0000000..d4ebb84 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Typst unofficial UniForLife Template + +![thumbnail](thumbnail.png) + +## Installation (Linux only) + +#### Using [`typship`](https://github.com/sjfhsjfh/typship) + +```bash +typship download -n local https://imsc.uni-graz.at/git/gjankowiak/typst-uniforlife-template +``` + +#### Manually + +```bash +mkdir -p ~/.local/share/typst/packages/local/uniforlife-document/ +cd ~/.local/share/typst/packages/local/uniforlife-document/ +curl https://imsc.uni-graz.at/git/gjankowiak/typst-uniforlife-template/archive/0.0.1.tar.gz | tar zx --xform 's/typst-uniforlife-document/0.0.1/' +``` + +## Quickstart (CLI) + +```sh +typst init @local/uniforlife-document document +``` + +Tested typst version: `0.14.0`.