Add README and example config

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

1 files changed, 25 insertions, 0 deletions

diff --git a/config.example.toml b/config.example.toml
new file mode 100644
index 0000000..7fe4d8a
--- /dev/null
+++ b/config.example.toml
@@ -0,0 +1,25 @@
+# cal-notif example config. Copy to ~/.config/cal-notif/config.toml.
+# Every key is optional; these are the defaults unless marked "example".
+
+calendars_dir = "~/.local/share/calendars"   # vdirsyncer filesystem storage
+snooze = "5m"                                # the popup's Snooze delay
+late = "10m"                                 # deliver alarms missed by at most this much
+rofi_theme = "~/.config/rofi/udt/list.rasi"
+
+# Alarms for events that have no VALARM, per calendar. The calendar name is
+# its vdirsyncer `displayname`, else its directory name. Durations are
+# "<n>d <n>h <n>m"; a list gives several alarms.
+[defaults]
+"*" = []                                     # silent unless the event has a VALARM
+# birthdays = ["1d", "9h"]                   # example
+# work = { offsets = ["15m"], voice = false } # example: popup only
+
+[voice]
+enabled = true
+model = "/data/voice-models/kokoro/kokoro-v1.0.onnx"
+voices = "/data/voice-models/kokoro/voices-v1.0.bin"
+lang = "it"
+blend = { if_sara = 0.8, af_bella = 0.2 }
+lead_silence = 0.3                           # raise if the first word gets clipped
+say = "Tra {in}: {summary}"
+say_now = "Adesso: {summary}"