aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/README.md b/README.md
index a8ebce5..5c0e3ea 100644
--- a/README.md
+++ b/README.md
@@ -2,17 +2,21 @@ ttym - terminal countdown / stopwatch
=====================================
A small countdown timer and stopwatch in C. Single binary, libc-only,
-no daemon. Default build is intentionally minimal:
+no daemon. The base build is terminal-only -- it writes no files and
+spawns no processes:
- T-24:13 +00:47 [>>>>>>>>>>------------------------------] 25%
+ 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
+ - progress bar with eight styles (`--bar`, auto-detected by locale)
+ - alert until keypress on completion (`--no-persist` to disable),
+ with an optional reverse-video flash (`--flash on|off`)
-Anything beyond that is an optional patch under patches/. See
-patches/README for the available set and apply order.
+Every feature that touches the filesystem, runs a subprocess or needs
+an external binary is an optional patch under patches/ -- desktop
+notifications, session logging, hooks and a runtime config file. See
+patches/README for the set and apply order.
Requirements
@@ -54,6 +58,9 @@ Usage
FLAGS:
-q no sound
-s silent
+ --no-persist skip alert-until-keypress loop
+ --flash on|off terminal flash during alert loop
+ --bar STYLE bar style: unicode|ascii|hash|dots|line|block|arrow|minimal
-- end of options
-h help