From cabc0b59de942f53a0d2d205f255ca0a40878732 Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Wed, 13 Dec 2023 12:54:25 +0100 Subject: [PATCH] Incorporate feedback from @dvzrv and @heiko --- CONTRIBUTING.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 76b9c86..99673b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,17 +23,23 @@ The included book projects can be built and tested using a `Makefile`. The following packages need to be installed on the system in order for the build to suceed: -* `inkscape` +* [inkscape](https://inkscape.org) * `make` -* `python3-myst-parser` -* `python3-sphinx` -* `python3-sphinxext-opengraph` +* [myst-parser](https://github.com/executablebooks/MyST-Parser) +* [sphinx](https://github.com/sphinx-doc/sphinx/) +* [sphinxext-opengraph](https://github.com/wpilibsuite/sphinxext-opengraph) -Optional dependencies: +Required fonts: -* `codespell` -* `lychee`: [Installation](https://lycheeorg.github.io/docs/#installation) -* `epubcheck`: [Installation](https://www.w3.org/publishing/epubcheck/docs/installation/) +* [Montserrat](https://github.com/JulietaUla/Montserrat) +* [Noto](https://fonts.google.com/noto) + +Optional test/check dependencies: + +* [codespell](https://github.com/codespell-project/codespell) +* [lychee](https://lychee.cli.rs/) +* [epubcheck](https://github.com/w3c/epubcheck) +* [watchexec](https://github.com/watchexec/watchexec) The below examples show how to use it with a book named `book`.