From dbb628012a76b5229696adcc58e01f8b532e3f06 Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Wed, 13 Dec 2023 12:56:30 +0100 Subject: [PATCH] Move requirements to own section --- CONTRIBUTING.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99673b6..223092b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,9 +17,7 @@ This project uses [sphinx] and [MyST-parser] to allow building various output fo Contributors can provide changes by pull request towards the project. -### Building and testing - -The included book projects can be built and tested using a `Makefile`. +### Requirements The following packages need to be installed on the system in order for the build to suceed: @@ -41,6 +39,10 @@ Optional test/check dependencies: * [epubcheck](https://github.com/w3c/epubcheck) * [watchexec](https://github.com/watchexec/watchexec) +### Building and testing + +The included book projects can be built and tested using a `Makefile`. + The below examples show how to use it with a book named `book`. To cleanly build the [HTML] output: