aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index a079f52..47b57d0 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,13 @@ The config file should be located at `${XDG_CONFIG_HOME}/bunnytask/config.ini` &
* `todo_path` *(required)*: the location of the TODO.TXT file(s). Supports multiple entries *(for multiple to-do files)* & `~`.
+## Building
+
+Bunnytask only requires [Hare](https://harelang.org/) to build. The standard set of Make options are available _(such as clean & install)_, and two flags are available:
+
+- `DEBUG=1` enables address sanitisation.
+- `RELEASE=1` builds Bunnytask using Hare's release mode, which strips runtime debugging tools.
+
## Contributing
Patches & bug reports are welcome! Simply email the patch to [bugs+bunnytask@autumnfo.rest](mailto:bugs+bunnytask@autumnfo.rest) and I will take a look. :3