add readme and license

This commit is contained in:
Joe Ardent 2022-10-14 15:24:29 -07:00
parent 7a8c8689d5
commit 827af8aea3
3 changed files with 25 additions and 0 deletions

5
LICENSE.md Normal file
View file

@ -0,0 +1,5 @@
# The Chaos License (GLP)
This software is released under the terms of the Chaos License. In cases where the terms of the
license are unclear, refer to the [Fuck Around and Find Out
License](https://git.sr.ht/~boringcactus/fafol/tree/master/LICENSE-v0.2.md).

20
README.md Normal file
View file

@ -0,0 +1,20 @@
# Katabastird: a simple countdown timer
Katabastird is a simple countdown timer that is configured and launched from the commandline.
``` text
Usage: katabastird [OPTIONS]
Options:
--hours <HOURS> Hours to count down [default: 0]
-m, --minutes <MINUTES> Minutes to count down [default: 0]
-s, --seconds <SECONDS> Seconds to count down [default: 0]
-a, --alarm <ALARM> Audio file to play at the end of the countdown
-r, --running Begin countdown immediately
-u, --count-up Count up from zero, actually
-p, --predator Use the Predator font
-h, --help Print help information
-V, --version Print version information
```
![a Predator's view of the timer while it's paused](./predator_timer_small.png)

BIN
predator_timer_small.png Normal file

Binary file not shown.

After

(image error) Size: 17 KiB