vanitasvitae/openpgp-notes
1
0
Fork 0
mirror of https://codeberg.org/openpgp/notes.git synced 2025-09-09 11:19:41 +02:00
Code Issues Projects Releases Packages Wiki Activity

Incorporate feedback from @dvzrv and @heiko

Browse source
This commit is contained in:
Paul Schaub 2023-12-13 12:54:25 +01:00
parent 86090d454c
commit cabc0b59de
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 14 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

22
CONTRIBUTING.md
View file

@ -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`.