From cff8d06debfacc50f6b2be95813b01ac7d026bef Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Wed, 13 Dec 2023 11:27:11 +0100 Subject: [PATCH] Contributing: List required dependencies (tested on vanilly Fedora 38) --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d0e9f38..c5b0243 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,6 +21,20 @@ Contributors can provide changes by pull request towards the project. 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` +* `make` +* `python3-myst-parser` +* `python3-sphinx` +* `python3-sphinxext-opengraph` + +Optional dependencies: + +* `codespell` +* `lychee` +* `epubcheck` + The below examples show how to use it with a book named `book`. To cleanly build the [HTML] output: