diff --git a/README.org b/README.org new file mode 100644 index 0000000..e770cc0 --- /dev/null +++ b/README.org @@ -0,0 +1,28 @@ +RASE - Run At Sun Event + +This is an Emacs extension that allows user provided set of functions +to be run at some sun events, right now - sunrise and sunset. + +Usage example: + +#+BEGIN_SRC emacs-lisp +(require 'rase) + +;; create a one argument function to be invoked at sun events +(defun switch-themes (sun-event) + "Switch themes on sunrise and sunset." + (cond ((eq sun-event 'sunrise) + (ignore-errors + (disable-theme 'wombat)) + (enable-theme 'whiteboard)) + ((eq sun-event 'sunset) + (ignore-errors + (disable-theme 'whiteboard)) + (enable-theme 'wombat)))) + +;; sign this function to be invoked on sun events +(add-to-list rase-hook 'switch-themes) + +;; start the run-at-sun-event daemon +(rase-start t) +#+END_SRC diff --git a/rase.el b/rase.el index 3b0b825..970681b 100644 --- a/rase.el +++ b/rase.el @@ -20,6 +20,22 @@ ;; along with GNU Emacs. If not, see . ;;; Commentary: +;; This is an Emacs extension that allows user provided set of +;; functions to be run at some sun events. + +;;; Usage: +;; create a one argument function to be invoked at sun events, like +;; (defun switch-themes (sun-event) +;; (cond ((eq sun-event 'sunrise) +;; ...set ligthish theme...) +;; ((eq sun-event 'sunset) +;; ...set darkish theme...))) + +;; sign this function to be invoked on sun events +;; (add-to-list rase-hook 'switch-themes) + +;; start the run-at-sun-event daemon +;; (rase-start t) ;;; Code: