From afabe1a381f4991e1758ffe6e20705714513d45d Mon Sep 17 00:00:00 2001 From: Federico <55920584+federico-busato@users.noreply.github.com> Date: Mon, 16 Mar 2026 11:01:17 -0700 Subject: [PATCH] small contributing guide lines improvements --- CONTRIBUTING.md | 10 +++++----- README.md | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 322229c..1e7ed24 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,19 +46,19 @@ Install Typst by following the [official instructions](https://github.com/typst/ - **CLI**: `cargo install typst-cli` (requires Rust), or download a prebuilt binary from [releases](https://github.com/typst/typst/releases). - **Web app**: [typst.app](https://typst.app/) for quick editing (no local setup needed). +### Typst Packages + +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). + ### Required Fonts -The following fonts must be installed on your system for local compilation: +The following fonts should be installed on your system to get the best visual experience: - [Latin Modern Sans](https://www.fontsquirrel.com/fonts/Latin-Modern-Sans) - [Latin Modern Mono](https://www.fontsquirrel.com/fonts/Latin-Modern-Mono) - [Latin Modern Roman Caps](https://www.fontsquirrel.com/fonts/TeX-Gyre-Cursor) (part of the Latin Modern family) - [Font Awesome 7 Free](https://fontawesome.com/download) (`Free-Regular-400.otf`) -### Typst Packages - -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). - ### Editor Setup (VS Code / Cursor) 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: diff --git a/README.md b/README.md index 65c0bc6..7c0a507 100644 --- a/README.md +++ b/README.md @@ -377,7 +377,7 @@ Font for coding. ## Reporting Bugs 🐛 and Contributing -If you find any typo, conceptual error, or section to improve, please report it using the `Issues` panel. +Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information. ## Where the Course has been used