branch: externals/olivetti
commit 30e3cbeb958315c9bea29654adca39b4af048b4d
Author: Paul Rankin <[email protected]>
Commit: Paul Rankin <[email protected]>
Added README/Commentary
---
README.md | 41 +++++++++++++++++++++++++++++++++++++++++
olivetti.el | 42 +++++++++++++++++++++++++++++++++++++++++-
2 files changed, 82 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5521b71
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+Olivetti
+========
+
+Olivetti is a simple Emacs minor mode for a nice writing environment.
+
+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"
+
+Requirements
+------------
+
+- Emacs 24.1 (not tested on earlier versions, only tested on Mac OS X
+ and Linux, not tested on Windows).
+
+Installation
+------------
+
+Olivetti is available through [MELPA][] and [MELPA-stable][]. I
+encourage installing the stable version.
+
+[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"
+
+History
+-------
+
+See [Releases][].
+
+[releases]: https://github.com/rnkn/olivetti/releases "Olivetti releases"
diff --git a/olivetti.el b/olivetti.el
index cc93a36..e3fd042 100644
--- a/olivetti.el
+++ b/olivetti.el
@@ -20,7 +20,47 @@
;;; Commentary:
-;;
+;; Olivetti
+;; ========
+
+;; Olivetti is a simple Emacs minor mode for a nice writing environment.
+
+;; 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"
+
+;; Requirements
+;; ------------
+
+;; - Emacs 24.1 (not tested on earlier versions, only tested on Mac OS X
+;; and Linux, not tested on Windows).
+
+;; Installation
+;; ------------
+
+;; Olivetti is available through [MELPA][] and [MELPA-stable][]. I
+;; encourage installing the stable version.
+
+;; [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"
+
+;; History
+;; -------
+
+;; See [Releases][].
+
+;; [releases]: https://github.com/rnkn/olivetti/releases "Olivetti releases"
;;; Code:
