From e32461d90a6a865328a90b2bf539e5936e858b38 Mon Sep 17 00:00:00 2001
From: Autumn
Date: Wed, 26 Aug 2026 17:55:36 +0100
Subject: [build] added instructions to README

---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'README.md')

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
-- 
cgit v1.3