From 5916a938348fe617dff61c415efcccd87a92d7e4 Mon Sep 17 00:00:00 2001 From: "Danilo M." Date: Fri, 18 Sep 2026 17:12:21 +0200 Subject: docs: point the Sounds section at variables that take effect SOUND_DIR is expanded into SYS_SOUND_* before breaktimer.conf is sourced, so setting it in the config file does nothing. Name the variables that actually take effect, and correct the claim that a config syntax error aborts the start: bash reports it and carries on with the defaults. --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 228b22f..234abf5 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ Defaults use the [Modern Minimal UI](https://github.com/cadecomposer/modern-mini Three events map to `message-new-instant.oga` (micro), `alarm-clock-elapsed.oga` (long), `service-login.oga` (back to work). Don't have that set? Either install -it there, or set `SOUND_DIR` / `SYS_SOUND_*` in `~/.config/breaktimer.conf` +it there, or set `SOUND_*` (or `SYS_SOUND_*`) in `~/.config/breaktimer.conf` (see Configuration below) to point at any `.oga`/`.wav` you like (e.g. the freedesktop sounds in `/usr/share/sounds/freedesktop/stereo/`). A missing file is simply silent — no error. @@ -112,8 +112,9 @@ breaktimer.sh config ``` The file is read when the daemon starts, so a change takes effect on -`breaktimer.sh restart`. A syntax error in it is a bash error at start, -reported on stderr. +`breaktimer.sh restart`. A syntax error in it is reported on stderr, but the +script can carry on with the defaults; run `breaktimer.sh config` to confirm +the values actually in effect. The check for all of this is `./test-breaktimer-config.sh`. -- cgit v1.2.3