From 68773374002df203775fa1d3870287e531f3fd20 Mon Sep 17 00:00:00 2001 From: gravel Date: Wed, 9 Aug 2023 20:02:27 +0000 Subject: [PATCH] Add doxygen to development instructions --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b4f78858..1f92bac0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,7 @@ - `entr` to watch for file changes - `xdg-open` link handler to invoke browser - `libgd` (`php-gd`, `phpX.Y-gd`) for downsizing images +- (Optional) `doxygen` to generate documentation ### Official repositories @@ -37,6 +38,8 @@ Recommended: - Symlink the commit hooks provided in [`etc/hooks`](etc/hooks/) to `.git/hooks/` to run a full test cycle when committing to main. +- Use `doxygen` (or `make docs`) to generate documentation you can reference when developing. + ### Running your own copy - point your webserver at the [`output`](output/) folder