Development setup

To set up your development environment, install Git, Make, Ruby, and a Go compiler, e.g.:

sudo apt install git golang make ruby-rubygems

In order to generate the website (with make site), you will also need Curl, PlantUML, Python, and R. (Curl and Python are probably already installed on your system.)

sudo apt install plantuml r-base-core

Then install the linting tools:

go install golang.org/x/vuln/cmd/govulncheck@latest
go install honnef.co/go/tools/cmd/staticcheck@latest

Clone the source code:

git clone https://git.sr.ht/~javiljoen/doxyte
cd doxyte

Run make check to verify that everything is set up correctly.

Set up Git hooks:

echo "make check check-deps" > .git/hooks/pre-push
chmod +x .git/hooks/pre-push

If you are me, you will also need hut in order to publish the docs.