orca
/
math-typst
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated the README.md documentation.

This commit is contained in:
orca 2024-01-21 11:32:17 +01:00
parent eca984b4db
commit c2c0181830
Signed by: orca
GPG Key ID: 6923B8DFED96A68A
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -6,6 +6,15 @@ A mathematical-oriented template for Typst.
Clone the repository, and start writing your paper in `source/main.typ`.
See the `example.typ` file for an example of the workflow it provides.
### Recommended workflow
If there is any updates, run `git pull`.
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.
For an example of how this looks, see this [this image](https://git.disroot.org/orca/home/src/branch/main/images/desktop.png).
When there will be updates, run `git pull`.
## How to get started
See the `example.typ` file for an example of it's usage. Open an issue if there's a documentation bug, or if you wish for new functionalities.