aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 54edbf8a3c36d878b2f4dfb7dc09314b28bb30f3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Bunnytask

Bunnytask is a simple TODO.TXT manager, written in [Hare](https://harelang.org/).

View release changes in the [CHANGELOG](CHANGELOG.md).

## Configuration

The config file should be located at `${XDG_CONFIG_HOME}/bunnytask/config.ini` & is required to run. The following configuration options are available:

* `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

No LLM / AI-assisted contributions welcome - if you do I will explosion you.

Licensed under GPLv3 - view the full license [here](LICENSE).