ui/zen: revise readme

This commit is contained in:
Henrik Lissner 2020-01-09 23:17:49 -05:00
parent c97f63beb8
commit c9b54ad279
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395

View file

@ -7,6 +7,7 @@
- [[#description][Description]] - [[#description][Description]]
- [[#module-flags][Module Flags]] - [[#module-flags][Module Flags]]
- [[#plugins][Plugins]] - [[#plugins][Plugins]]
- [[#hacks][Hacks]]
- [[#prerequisites][Prerequisites]] - [[#prerequisites][Prerequisites]]
- [[#features][Features]] - [[#features][Features]]
- [[#distractions-free-mode][Distractions-free mode]] - [[#distractions-free-mode][Distractions-free mode]]
@ -14,11 +15,12 @@
- [[#enable-fullscreen-on-activation][Enable fullscreen on activation]] - [[#enable-fullscreen-on-activation][Enable fullscreen on activation]]
* Description * Description
This module provides a distraction-free mode that: This module provides ~writeroom-mode~, which transforms Emacs into a
comfortable writing or coding space by centering the buffer, removing
superfluous UI elements, and turning on variable-pitch fonts (but keeps certain
elements fixed-pitch, where it makes sense to).
+ Centers the buffer If you've used olivetti, sublimity, or tabula-rasa, you will feel right at home.
+ Enables variable pitch for text (but keeps certain elements fixed-pitch).
+ Reduces UI clutter (e.g. the modeline; fullscreens the frame -- off by default)
** Module Flags ** Module Flags
This module provides no flags. This module provides no flags.
@ -27,6 +29,11 @@ This module provides no flags.
+ [[https://github.com/joostkremers/writeroom-mode][writeroom-mode]] + [[https://github.com/joostkremers/writeroom-mode][writeroom-mode]]
+ [[https://gitlab.com/jabranham/mixed-pitch][mixed-pitch]] + [[https://gitlab.com/jabranham/mixed-pitch][mixed-pitch]]
** Hacks
+ =mixed-pitch= has been modified not to override ~:height~ properties on the
faces it remaps. This means text-scale can affect the ~fixed-pitch~ faces as
well; See https://gitlab.com/jabranham/mixed-pitch/issues/6#note_79691741.
* Prerequisites * Prerequisites
This module has no prereqisites. This module has no prereqisites.