diff options
| author | Autumn | 2026-08-26 17:55:36 +0100 |
|---|---|---|
| committer | Autumn | 2026-08-26 17:55:36 +0100 |
| commit | e32461d90a6a865328a90b2bf539e5936e858b38 (patch) | |
| tree | ea2c722334ac83094f521d7f720b181508c14768 /README.md | |
| parent | 967535f44673b18a12804d2b50e544dedb31d228 (diff) | |
[build] added instructions to README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 7 |
1 files changed, 7 insertions, 0 deletions
@@ -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 |