diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 38 |
1 files changed, 18 insertions, 20 deletions
@@ -27,7 +27,7 @@ Customizable org notifications for Emacs with visual alerts, audible chimes, and :CUSTOM_ID: about :END: -CHIME (backronym: *CHIME Heralds Imminent Modeline Events*) provides notification support for your org-agenda events. Get visual notifications, a pleasant chime sound, and see your next upcoming event in your modeline. +CHIME (backronym: *CHIME Heralds Imminent Modeline Events*) notifies you about upcoming org-agenda events. You get desktop notifications, an audible chime, and your next event shows up in the modeline. This is an updated and maintained fork of the abandoned [[https://github.com/akhramov/org-wild-notifier.el][org-wild-notifier]] project, renamed to CHIME with bug-fixes and new features. @@ -41,7 +41,7 @@ Note: while I've found this package to be quite reliable, it's still undergoing - *Visual notifications* with customizable alert times - *Audible chime sound* when notifications are displayed (bundled WAV or custom file) - *Customizable notification icon* for desktop notifications -- *Interactive modeline display* of next upcoming event with extensive customization: +- *Interactive modeline display* of next upcoming event, highly configurable: - Enable/disable modeline modifications - Hover tooltip showing all upcoming events grouped by day - Click to jump directly to event's org entry @@ -186,7 +186,7 @@ Set when to receive notifications and their urgency levels using (minutes . seve (0 . high))) ;; At event time: high urgency #+END_SRC -Severity levels (=high=, =medium=, =low=) control notification urgency and may affect how your notification system displays them. +Severity levels (=high=, =medium=, =low=) affect how your notification daemon displays them (e.g., notification persistence, sound). *** Chime Sound @@ -203,7 +203,7 @@ Control the audible chime that plays when notifications appear: (setq chime-sound-file nil) #+END_SRC -The package includes a pleasant chime sound in GPL-compatible WAV format. You can use your own sound file if preferred. +A bundled chime.wav is included (GPL-licensed). Swap in your own WAV if you prefer. *** Notification Icon @@ -357,9 +357,7 @@ The tooltip can show events beyond the modeline lookahead window. By default, it Note: larger values increase the agenda span fetched by the async subprocess, which can slow event checks if you have many org files. -This separation allows you to: -- Keep the modeline focused on imminent events (tactical view) -- See a broader timeline in the tooltip (strategic view) +This way the modeline stays focused on what's imminent, while the tooltip gives you a wider view of what's coming up. ***** Click Actions @@ -557,7 +555,7 @@ For maximum modeline space savings: **** Whitelist and Blacklist Precedence -If the same keyword or tag appears in both a whitelist and blacklist, the *blacklist takes precedence* and the item will be filtered out. This ensures sensitive information cannot accidentally be exposed in notifications. +If the same keyword or tag appears in both a whitelist and blacklist, the *blacklist wins* and the item is filtered out. Examples: - Item with =TODO= keyword when =TODO= is in both ~chime-keyword-whitelist~ and ~chime-keyword-blacklist~ → *filtered out* (blacklist wins) @@ -751,7 +749,7 @@ Control whether all-day events (birthdays, holidays, etc.) appear in the modelin All-day events are never shown in the modeline itself (only timed events appear there). This setting controls only the tooltip display. Notifications are unaffected. -***** Understanding the Interplay with Alert Times +***** How alert times and overdue settings interact The relationship between =chime-day-wide-alert-times= and =chime-show-any-overdue-with-day-wide-alerts= can be confusing: @@ -1072,15 +1070,15 @@ If something isn't working right, enable debug mode for detailed diagnostics in (require 'chime) #+END_SRC -This loads =chime-debug.el= and provides several diagnostic commands: +This loads =chime-debug.el= and gives you these commands: -- =M-x chime--debug-dump-events= — show all stored upcoming events -- =M-x chime--debug-dump-tooltip= — show tooltip content -- =M-x chime--debug-config= — dump complete configuration -- =M-x chime--debug-show-async-stats= — show async process success/failure stats -- =M-x chime-debug-force-check= — force an immediate check with diagnostics +- =M-x chime--debug-dump-events= -- show all stored upcoming events +- =M-x chime--debug-dump-tooltip= -- show tooltip content +- =M-x chime--debug-config= -- dump complete configuration +- =M-x chime--debug-show-async-stats= -- show async process success/failure stats +- =M-x chime-debug-force-check= -- force an immediate check with diagnostics -Debug mode also automatically monitors event loading timing and async process performance, logging details to =*Messages*=. +It also monitors event loading timing and async process performance in the background, logging to =*Messages*=. *** No notifications appearing @@ -1230,7 +1228,7 @@ emacs & # This creates a SECOND chime instance! :CUSTOM_ID: testing :END: -Chime includes a comprehensive test suite with 600+ tests covering all functionality. For detailed information about running tests, test architecture, and development workflows, see [[file:TESTING.org][TESTING.org]]. +600+ ERT tests. See [[file:TESTING.org][TESTING.org]] for details on running them and the test architecture. Quick start: #+BEGIN_SRC bash @@ -1251,9 +1249,9 @@ GPL-3.0 :CUSTOM_ID: credits :END: -All credit and thanks should go to Artem Khramov for his work on [[https://github.com/akhramov/org-wild-notifier.el][org-wild-notifier]], which served me well for some time. Sadly, the author deprecated org-wild-notifier on Aug 2, 2025 in favor of [[https://github.com/spegoraro/org-alert][org-alert]]. I begain fixing bugs and enhancing the feature set into what is now CHIME. +All credit and thanks to Artem Khramov for his work on [[https://github.com/akhramov/org-wild-notifier.el][org-wild-notifier]], which served me well for some time. Sadly, the author deprecated org-wild-notifier on Aug 2, 2025 in favor of [[https://github.com/spegoraro/org-alert][org-alert]]. I began fixing bugs and adding features, and it eventually became CHIME. -I plan to maintain this in appreciation and gratitude of Artem's work, and for the larger Emacs community. +I plan to keep maintaining this out of appreciation for Artem's work and for the Emacs community. ** Migration from org-wild-notifier :PROPERTIES: @@ -1279,5 +1277,5 @@ If you're migrating from org-wild-notifier, you'll need to update your configura :CUSTOM_ID: development :END: -For information about running tests, test architecture, and development workflows, see [[file:TESTING.org][TESTING.org]]. +See [[file:TESTING.org][TESTING.org]]. |