2024-01-16 08:13:37 +01:00
|
|
|
# math-typst
|
|
|
|
|
|
2024-01-25 22:41:47 +01:00
|
|
|
A mathematical-oriented template and work environment for Typst.
|
2024-01-16 08:13:37 +01:00
|
|
|
|
|
|
|
|
## How to use
|
|
|
|
|
|
2024-01-21 11:41:48 +01:00
|
|
|
Clone the repository, and start writing your paper in `source/user/main.typ`.
|
2024-01-21 10:03:43 +01:00
|
|
|
|
2024-01-21 11:32:17 +01:00
|
|
|
### Recommended workflow
|
2024-01-21 10:03:43 +01:00
|
|
|
|
2024-01-21 11:32:17 +01:00
|
|
|
I recommend you run `make watch` to make use of incremental compilation. Then, run `make view`, after setting the `PDF_VIEWER` shell variable.
|
|
|
|
|
Now, just save your file whenever you wish to update the PDF.
|
|
|
|
|
|
2024-02-03 04:18:57 +01:00
|
|
|
For an example of how this looks, see [this image](https://git.disroot.org/orca/home/src/branch/main/.images/desktop.png).
|
2024-01-21 11:32:17 +01:00
|
|
|
|
|
|
|
|
When there will be updates, run `git pull`.
|
|
|
|
|
|
|
|
|
|
## How to get started
|
|
|
|
|
|
2024-04-23 09:53:08 +02:00
|
|
|
See the `source/manual.typ` file for an example of its usage.
|
2024-02-03 04:20:53 +01:00
|
|
|
|
2024-02-04 08:25:38 +01:00
|
|
|
Run `make manual` to compile it.
|
