docs: document installation in README

This commit is contained in:
Popa committed 2026-10-30 19:52:12 +01:00
1 parent e6a09ef7c3
commit 50d632dc6d
1 file changed
+20
+20
View File
@@ -2,6 +2,8 @@
A Typst template for mathematical lecture notes. A Typst template for mathematical lecture notes.
## Example Usage
```typst ```typst
#import "@local/lecture-notes:0.1.0": * #import "@local/lecture-notes:0.1.0": *
@@ -36,6 +38,24 @@ Style can be partially overridden:
) )
``` ```
## Installation
Since I don't want to include this package in the official Typst package registry (bc I'm too shy), you have to install it manually. To do so, you have to first find out where Typst stores packages on your system. Run the following command in your terminal:
```bash
typst info
```
and search for the line "Package path". In this folder, create a new folder called `local` (if it doesn't exist yet) and then simply clone this repository into a subfolder called `lecture-notes`. When you're done, the path to the `typst.toml` file should look like this:
```
<package path>/local/lecture-notes/0.1.0/typst.toml
```
Now you're ready to type your lecture notes. Enjoy :)
## Components
The package contains the following components: `lecture-notes`, `title-page`, `lecture`, `definition`, `axiom`, `theorem`, `lemma`, `corollary`, `exercise`, `qed`, `qed-equation`, `Im`, `Re` and `ord`. The package contains the following components: `lecture-notes`, `title-page`, `lecture`, `definition`, `axiom`, `theorem`, `lemma`, `corollary`, `exercise`, `qed`, `qed-equation`, `Im`, `Re` and `ord`.
`def`, `thm`, `satz`, `kor` and `korollar` stay for backwards compatibility. `def`, `thm`, `satz`, `kor` and `korollar` stay for backwards compatibility.