branch: externals/theme-buffet
commit dfcb3c509356c796bfbc9144faae1e9c69b949c3
Author: bboal <[email protected]>
Commit: bboal <[email protected]>
Added "Usage" heading in "Commentary" section
---
theme-buffet.el | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/theme-buffet.el b/theme-buffet.el
index 66215111d7..00120d307e 100644
--- a/theme-buffet.el
+++ b/theme-buffet.el
@@ -68,6 +68,34 @@
;; inspiration, take a look at `theme-buffet--modus-ef' which is used when
;; setting `theme-buffet-menu' to 'modus-ef like demonstrated above.
;;
+;;
+;; Usage:
+;;
+;; There are several interactive functions available to the user serving as
+;; entry points to the package.
+;;
+;; To set the menu for the desired themes property list and have the themes
+;; change when the periods do: `theme-buffet-built-in',
+;; `theme-buffet-modus-ef' and `theme-buffet-end-user'.
+;;
+;; To set the timer for a certain time interval of hours or minutes:
+;;`theme-buffet-timer-hours' or `theme-buffet-timer-mins'.
+;;
+;; To load a theme from the current period: `theme-buffet-a-la-carte'. If
+;; instead you want to load a random theme from a prompted period, there's
+;; `theme-buffet-order-other-period'. To load an existing random theme use
+;; `theme-buffet-anything-goes'.
+;;
+;; Some examples in lisp:
+;;
+;; (theme-buffet-modus-ef) ; to set the theme plist to Modus and Ef
+;; (theme-buffet-timer-mins 30) ; to change theme every 30m from now
+;; (theme-buffet-timer-hours 2) ; to also change every 2h from now
+;;
+;; Interactively, as an example, you would press M-x and execute
+;; `theme-buffet-order-other-period'. Then, after choosing any defined period,
+;;you would get returned a random loaded theme from the aforementioned period.
+
;;
;; Disclaimer from Bruno Boal to the reader: This package was produced during
my
;; learning sessions with Protesilaos "Prot" Stavrou and improved as
