From 2f6b29abd0d766ef477eb29c5a7bf6c1e88e9630 Mon Sep 17 00:00:00 2001 From: Lukasz Kasprzak Date: Wed, 20 May 2026 14:34:20 +0200 Subject: modified readme.md --- README.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..a8ebce5 --- /dev/null +++ b/README.md @@ -0,0 +1,67 @@ +ttym - terminal countdown / stopwatch +===================================== + +A small countdown timer and stopwatch in C. Single binary, libc-only, +no daemon. Default build is intentionally minimal: + + T-24:13 +00:47 [>>>>>>>>>>------------------------------] 25% + + - countdown when given a duration; stopwatch when not + - pause/resume with [space], quit with [q] or Ctrl+C + - ASCII progress bar + - one-shot terminal bell on completion + +Anything beyond that is an optional patch under patches/. See +patches/README for the available set and apply order. + + +Requirements +------------ + +A C compiler and POSIX make. No external libraries. + + +Installation +------------ + +Edit config.mk if needed, then: + + make + sudo make install # to $(PREFIX)/bin/timer ; default /usr/local + +Override the prefix at build time: + + make PREFIX=$HOME/.local install + +The installed binary is named `timer`. + + +Configuration +------------- + +Compile-time knobs live in config.def.h. On first build the Makefile +copies it to config.h; edit config.h and re-`make` to change defaults. + + +Usage +----- + + timer [FLAGS] DURATION countdown + timer [FLAGS] stopwatch + + DURATION: 25m | 90s | 2h | 1h30m | 01:30:00 | 25:00 + + FLAGS: + -q no sound + -s silent + -- end of options + -h help + +`timer -h` always reflects the build: each patch updates the help text +in lockstep with the flags it adds. + + +License +------- + +MIT. See LICENSE. -- cgit v1.3