Files
tultemplate2/README.md

26 lines
756 B
Markdown

# tultemplate2
Easy Typst template for TUL documents. Begin by compiling `example.typ` and reading it.
## How to compile
It is recommended to use either:
- The on-line Typst editor (https://typst.app/play/) - use some zip build from releases
(https://git.zumepro.cz/tul/tultemplate2/releases).
- The `typst` CLI tool (available in Arch repos and Snap)
On Linux, with the `typst` command available, you can just run:
```sh
make
```
That will compile the example document and view it.
## Repo structure note
> [!IMPORTANT]
> This repo uses git lfs to pull fonts. Please set it up (or download a packed build from releases).
> When running in CLI - you'll want to include the embedded fonts:
> `typst compile --font-path template/fonts example.typ`