diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..589cfb6 --- /dev/null +++ b/LICENSE.md @@ -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). diff --git a/README.md b/README.md new file mode 100644 index 0000000..09d4b3a --- /dev/null +++ b/README.md @@ -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 to count down [default: 0] + -m, --minutes Minutes to count down [default: 0] + -s, --seconds Seconds to count down [default: 0] + -a, --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) diff --git a/predator_timer_small.png b/predator_timer_small.png new file mode 100644 index 0000000..483850d Binary files /dev/null and b/predator_timer_small.png differ