Skip to content

Commit afabe1a

Browse files
small contributing guide lines improvements
1 parent 3eef9ba commit afabe1a

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,19 +46,19 @@ Install Typst by following the [official instructions](https://github.com/typst/
4646
- **CLI**: `cargo install typst-cli` (requires Rust), or download a prebuilt binary from [releases](https://github.com/typst/typst/releases).
4747
- **Web app**: [typst.app](https://typst.app/) for quick editing (no local setup needed).
4848

49+
### Typst Packages
50+
51+
The project uses several Typst packages which are automatically resolved on compilation. The presentation framework used for draw the slides is [`touying`](https://typst.app/universe/package/touying).
52+
4953
### Required Fonts
5054

51-
The following fonts must be installed on your system for local compilation:
55+
The following fonts should be installed on your system to get the best visual experience:
5256

5357
- [Latin Modern Sans](https://www.fontsquirrel.com/fonts/Latin-Modern-Sans)
5458
- [Latin Modern Mono](https://www.fontsquirrel.com/fonts/Latin-Modern-Mono)
5559
- [Latin Modern Roman Caps](https://www.fontsquirrel.com/fonts/TeX-Gyre-Cursor) (part of the Latin Modern family)
5660
- [Font Awesome 7 Free](https://fontawesome.com/download) (`Free-Regular-400.otf`)
5761

58-
### Typst Packages
59-
60-
The project uses several Typst packages which are automatically resolved on compilation. The presentation framework used for draw the slides is [`touying`](https://typst.app/universe/package/touying).
61-
6262
### Editor Setup (VS Code / Cursor)
6363

6464
The recommended way to work with Typst sources is through [VS Code](https://code.visualstudio.com/) or [Cursor](https://www.cursor.com/) with the [Tinymist](https://myriad-dreamin.github.io/tinymist/frontend/vscode.html) extension:

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ Font for coding.
377377

378378
## Reporting Bugs 🐛 and Contributing
379379

380-
If you find any typo, conceptual error, or section to improve, please report it using the `Issues` panel.
380+
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.
381381

382382
## Where the Course has been used
383383

0 commit comments

Comments
 (0)