From 14667b48b20766be3055f144a2b0e326fe7c411d Mon Sep 17 00:00:00 2001
From: Gaspard Jankowiak <gaspard.jankowiak@uni-graz.at>
Date: Tue, 14 Apr 2026 15:53:44 +0200
Subject: [PATCH] add README

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

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