From 198f1a7e1e7eb9490e2adeecb5cccf1ab5859bec Mon Sep 17 00:00:00 2001 From: Paul Tsouchlos Date: Wed, 18 Sep 2024 14:36:22 -0600 Subject: [PATCH] docs: update README with updated setup instructions Document what tools are needed when developing the template. --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d60837e..2b50fbf 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,17 @@ A port of the [Awesome-CV](https://github.com/posquit0/Awesome-CV) Latex resume ## Requirements +### Tools + +The following tools are used for the development of this template: + +- [typst](https://github.com/typst/typst), obviously +- [typst-test](https://github.com/tingerrr/typst-test) for running tests +- [just](https://github.com/casey/just) for simplifying command running +- [oxipng](https://github.com/shssoichiro/oxipng) for compressing thumbnails used in the README + +### Fonts + You will need the `Roboto` and `Source Sans Pro` fonts installed on your system or available somewhere. If you are using the `typst` web app, no further action is necessary. You can download them from the following links: - [Roboto](https://fonts.google.com/specimen/Roboto) @@ -83,17 +94,19 @@ Documentation for this template is published with each commit. See the attached To build and test the project locally, you will need to install the `typst` CLI. You can find instructions on how to do this [here](https://typst.app/docs/getting-started). -With typst installed you can make changes to `lib.typ` and then `install_package_locally.ps1` to install the package locally. Change the import statements in the template files to point to the local package: +With typst installed you can make changes to `lib.typ` and then `just install` or `just install-preview` to install the package locally. Change the import statements in the template files to point to the local package (if needed): ```typst -#import "@local/modern-cv:0.3.0": * +#import "@local/modern-cv:0.6.0": * ```` +If you use `just install-preview` you will only need to update the version number to match `typst.toml`. + Note that the script parses the `typst.toml` to determine the version number and the folder the local files are installed to. ### Formatting -This project uses [typstyle](https://github.com/Enter-tainer/typstyle) to format the code. The script `format_typst.ps1` will format all the `*.typ` files in the project. Be sure to install `typstyle` before running the script. +This project uses [typstyle](https://github.com/Enter-tainer/typstyle) to format the code. Run `just format` to format all the `*.typ` files in the project. Be sure to install `typstyle` before running the script. ## License