branch: externals/olivetti
commit c2b11008912f35ef9d379359115b5bf091670449
Author: Paul Rankin <he...@paulwrankin.com>
Commit: Paul Rankin <he...@paulwrankin.com>
Updated README and Commentary
---
README.md | 31 +++++++++++++++++++------------
olivetti.el | 23 +++++++++++------------
2 files changed, 30 insertions(+), 24 deletions(-)
diff --git a/README.md b/README.md
index 5521b71..8347b9c 100644
--- a/README.md
+++ b/README.md
@@ -3,25 +3,29 @@ Olivetti
Olivetti is a simple Emacs minor mode for a nice writing environment.
-Features
---------
+
+
+Pictured: *Big Fish* by John August using using text body width of 66
+(top, also using [Fountain Mode][]), lorem ipsum text using text body
+width of 80 (bottom)
-- set a desired text body width to automatically resize window margins
- to keep the text comfortably in the middle of the window
-- text body width can be the number of characters (an integer) or a
- fraction of the window width (a float between 0.0 and 1.0)
-- optionally hide the modeline for distraction-free writing
+[fountain mode]: https://github.com/rnkn/fountain-mode
-Olivetti actually duplicates a subset of features already present in
-[Writeroom-mode][], but Olivetti keeps all features buffer-local.
+Features
+--------
-[writeroom-mode]: https://github.com/joostkremers/writeroom-mode
"Writeroom-mode"
+- Set a desired text body width to automatically resize window margins
+ to keep the text comfortably in the middle of the window.
+- Text body width can be the number of characters (an integer) or a
+ fraction of the window width (a float between 0.0 and 1.0).
+- Interactively change body width with `olivetti-expand`,
+ `olivetti-shrink` and `olivetti-set-width`.
+- Optionally hide the modeline for distraction-free writing.
Requirements
------------
-- Emacs 24.1 (not tested on earlier versions, only tested on Mac OS X
- and Linux, not tested on Windows).
+- Emacs 24.4
Installation
------------
@@ -29,6 +33,9 @@ Installation
Olivetti is available through [MELPA][] and [MELPA-stable][]. I
encourage installing the stable version.
+Alternately, download the [latest release][] and put it in your
+`load-path`.
+
[melpa]: http://melpa.milkbox.net "MELPA"
[melpa-stable]: http://melpa-stable.milkbox.net "MELPA"
[latest release]: https://github.com/rnkn/olivetti/releases/latest "Olivetti
latest release"
diff --git a/olivetti.el b/olivetti.el
index 71d9903..d12e691 100644
--- a/olivetti.el
+++ b/olivetti.el
@@ -28,22 +28,18 @@
;; Features
;; --------
-;; - set a desired text body width to automatically resize window margins
-;; to keep the text comfortably in the middle of the window
-;; - text body width can be the number of characters (an integer) or a
-;; fraction of the window width (a float between 0.0 and 1.0)
-;; - optionally hide the modeline for distraction-free writing
-
-;; Olivetti actually duplicates a subset of features already present in
-;; [Writeroom-mode][], but Olivetti keeps all features buffer-local.
-
-;; [writeroom-mode]: https://github.com/joostkremers/writeroom-mode
"Writeroom-mode"
+;; - Set a desired text body width to automatically resize window margins
+;; to keep the text comfortably in the middle of the window.
+;; - Text body width can be the number of characters (an integer) or a
+;; fraction of the window width (a float between 0.0 and 1.0).
+;; - Interactively change body width with `olivetti-expand`,
+;; `olivetti-shrink` and `olivetti-set-width`.
+;; - Optionally hide the modeline for distraction-free writing.
;; Requirements
;; ------------
-;; - Emacs 24.1 (not tested on earlier versions, only tested on Mac OS X
-;; and Linux, not tested on Windows).
+;; - Emacs 24.4
;; Installation
;; ------------
@@ -51,6 +47,9 @@
;; Olivetti is available through [MELPA][] and [MELPA-stable][]. I
;; encourage installing the stable version.
+;; Alternately, download the [latest release][] and put it in your
+;; `load-path`.
+
;; [melpa]: http://melpa.milkbox.net "MELPA"
;; [melpa-stable]: http://melpa-stable.milkbox.net "MELPA"
;; [latest release]: https://github.com/rnkn/olivetti/releases/latest
"Olivetti latest release"
