Running the project locally

Dependencies

If you plan on running this project only through GitHub actions, nothing needs to be installed.

If you want to run the project locally, the following need to be installed:

• git
• GitHub CLI (gh)
• GNU Make
• GNU Tar
• ImageMagick
• Nox
• Python

Running the project

If the needed depdendencies are installed, you can run

% nox --tags=build

to build the docset locally. and

% nox --tags=contribute

To contribute the built docset. These are the exact commands that are ran on GitHub actions.