branch: externals/theme-buffet
commit 4e9a20f00a4134a3defec8caebabc74a7375e120
Author: bboal <[email protected]>
Commit: bboal <[email protected]>
Added README.md for short explanation of the package
---
README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 75 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..08b2516667
--- /dev/null
+++ b/README.md
@@ -0,0 +1,75 @@
+# Theme-Buffet for GNU Emacs
+
+Theme-Buffet lets the user specify different time periods of the day and for
+each period, a list of preferred themes to be randomly loaded accordingly.
+
+
+## Installation
+
+To install you just have to clone the repo from the url, add the path to the
+'load-path variable and then require the library. Here's an example, for
+those who still love the Emacs 28 or earlier way of doing things:
+
+
+### In the terminal:
+
+ git clone https://git.sr.ht/~bboal/theme-buffet ~/.emacs.d/theme-buffet
+
+##### Then, in Emacs, evaluate:
+
+ (add-to-list 'load-path "~/.emacs.d/theme-buffet")
+
+ (require 'theme-buffet)
+
+
+### The newest way, from Emacs 29 onward:
+
+ (package-vc-install "https://git.sr.ht/~bboal/theme-buffet";)
+
+
+## Configuration
+
+There are two templates pre-configured available for usage. One enabled by
+default, with the standard themes that come with vanilla Emacs; the other
+more fancier, can be easily enabled by evaluating the following:
+
+ (setq theme-buffet-menu 'modus-ef)
+
+The binding above will set the themes to be either Modus or Ef, authored by
+Protesilaos Stavrou <https://git.sr.ht/~protesilaos>, distributed across six
+periods of the day (night, twilight, morning, day, afternoon and evening). The
+library will require the aforementioned package, installing if necessary.
+Finally to start using Theme-Buffet, evaluate:
+
+ (theme-buffet-mode 1)
+
+
+Following the appanage way of Emacs, both the names and number of themes and
+time periods can be freely changed while maintaining the same structure. There
+is also a time-offset that can be set by the user to match a specific
+time-zone/personal preference.
+E.g.
+
+ (setq theme-buffet-time-offset 2)
+
+All this can be achieved by tweaking `theme-buffet-end-user`. For
+inspiration, take a look at `theme-buffet--modus-ef` which is used when
+setting `theme-buffet-menu` to 'modus-ef like demonstrated above.
+
+
+## Disclaimer
+
+Disclaimer from Bruno Boal to the reader: This package was produced during
+my learning sessions with Protesilaos "Prot" Stavrou and improved as
+homework. Most of the credit goes to him, the mistakes you may find are my
+own. Personally, despite the disadvantages and advantages of not being a
+professional programmer, it is essential for me to always have fun and
+enjoyment during learning and programming. In this respect, mission
+accomplished, a big "thank you!" to my mentor. Also, keep in mind at least
+two things - the fact that this package, like many others before it, has its
+genesis in a collective effort, with didactic purposes and personal use in
+mind, but also that future improvements could and should come from people
+like you, a user of free software.
+
+
+Happy hacking!
