diff options
| author | Protesilaos Stavrou <info@protesilaos.com> | 2022-08-16 23:05:30 +0300 |
|---|---|---|
| committer | Protesilaos Stavrou <info@protesilaos.com> | 2022-08-16 23:05:30 +0300 |
| commit | 2b9b75c1a13f45f11ff6e811716ed86556698106 (patch) | |
| tree | 3b0928aab2428d3ea2866884eacfe042ac02f767 /README.md | |
| parent | 8986b3bf4b050b7976f48b2785ed81756551e199 (diff) | |
Add the manual
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 83 |
1 files changed, 13 insertions, 70 deletions
@@ -1,72 +1,15 @@ # Ef (εὖ) themes for GNU Emacs -WORK-IN-PROGRESS - -Colourful and legible themes. - -## Screenshots (PRE-RELEASE and WORK-IN-PROGRESS) - -**Those will be removed from the repo before the actual package is -released.** - -The themes in order: - -- `ef-spring` -- `ef-summer` -- `ef-day` -- `ef-night` -- `ef-winter` -- `ef-autumn` - - - - - - - - - - - - - -## Principles - -* No customisation options! Either you like them or you don't. - -* Curated list of supported packages. I will only cover what I use - and/or know is in a well-maintained state. - -* Minimum contrast ratio of 4.5:1 against the main background (WCAG AA - standard). Use my `modus-themes` package (also built into Emacs 28 or - higher) if you need top-class accessibility. - -## Minimal VS maximal scope - -The `ef-themes` are meant to be minimal in scope, as opposed to my -`modus-themes` whose accessibility requirements make them maximalist _by -necessity_. The `modus-themes` are such because: - -1. Accessibility is not a one-size-fits-all. Customisation options are - necessary to empower users. -2. Accessibility is as good as its weakest link. If the user spends all - day using FOO package, it needs to be perfectly legible, otherwise - the whole theme fails to deliver on its promise. - -The `ef-themes` can afford to be minimal because they do not have such a -lofty accessibility target. - -## FAQ - -### Will you stop using the modus-themes? - -No. For my workflow, accessibility is the most important quality. The -`modus-themes` will remain my default choice. - -### Then why develop the ef-themes? - -Because I think that users deserve "pretty" themes that (i) do make some -considerations for legibility, and (ii) are not designed on a whimsy. - -In other words, the `ef-themes` are my answer to those who like my -`modus-themes` but want something with a bit more flair. +WORK-IN-PROGRESS: screenshots will be available once things stabilise. + +The `ef-themes` are a collection of light and dark themes for GNU Emacs +whose goal is to provide colorful ("pretty") yet legible options for +users who want something with a bit more flair than the `modus-themes` +(also designed by me). + ++ Package name (GNU ELPA): `ef-themes` ++ Git repo on SourceHut: <https://git.sr.ht/~protesilaos/ef-themes> + - Mirrors: + + GitHub: <https://github.com/protesilaos/ef-themes> + + GitLab: <https://gitlab.com/protesilaos/ef-themes> ++ Mailing list: <https://lists.sr.ht/~protesilaos/ef-themes> |