add README.md

README.md

@@ -0,0 +1,77 @@
+# Unofficial KFU Typst report 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-kfu-report
+```
+
+#### Manually
+
+```bash
+mkdir -p ~/.local/share/typst/packages/local/kfu-report/
+cd  ~/.local/share/typst/packages/local/kfu-report/
+curl https://imsc.uni-graz.at/git/gjankowiak/typst-kfu-report/archive/0.1.0.tar.gz | tar zx --xform 's/typst-kfu-report/0.1.0/'
+```
+
+## Quickstart (CLI)
+
+```sh
+typst init @local/kfu-report report
+```
+
+
+## Template
+
+```typst
+#import "@local/kfu-report:0.1.0": report
+
+
+#report(
+  lang: "en",
+
+  title: [A nice report],
+  subtitle: [On an interesting topic],
+
+  date: datetime.today().display("[day] [month repr:long], [year]"),
+
+  department: [Department of Mathematics and \ Scientific Computing],
+
+  author: [
+    First Author \
+    Second Author
+  ])
+
+#outline()
+
+= Introduction
+
+== Some toughts
+
+#lorem(200)
+
+== Some more toughts
+
+#lorem(50)
+
+#lorem(200)
+
+= Main results
+
+#lorem(100)
+
+$ e^(i pi) + 1 = integral_0^(2 pi) sin(t) dif t $
+```
+
+
+Compile with
+
+```sh
+typst compile report.typ
+```
+
+Tested typst version: `0.14.2`.