[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/olivetti 30e3cbe 014/134: Added README/Commentary
From: |
Stefan Monnier |
Subject: |
[elpa] externals/olivetti 30e3cbe 014/134: Added README/Commentary |
Date: |
Thu, 25 Apr 2019 09:57:19 -0400 (EDT) |
branch: externals/olivetti
commit 30e3cbeb958315c9bea29654adca39b4af048b4d
Author: Paul Rankin <address@hidden>
Commit: Paul Rankin <address@hidden>
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:
- [elpa] externals/olivetti bd06cf1 004/134: Added mode-map and menu, (continued)
- [elpa] externals/olivetti bd06cf1 004/134: Added mode-map and menu, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 6533514 002/134: Added a bunch of custom options, allow body-width float, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti fd3d39d 006/134: Removed extraneous vars and fns, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 158db93 005/134: Added set-mode-line, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti af1d719 010/134: Revert "Using run-window-configuration-change-hook fn", Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 5cfe277 020/134: Changed body-width standard-value to 80, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 514bc46 009/134: Using run-window-configuration-change-hook fn, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 2363de6 008/134: Fixed margin reset on exit, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 885fb20 019/134: Added minimum-body-width, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 06bf86f 016/134: Add hook when changing fonts, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 30e3cbe 014/134: Added README/Commentary,
Stefan Monnier <=
- [elpa] externals/olivetti 869221a 013/134: Removed delete-selection-mode, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti ea4a25f 011/134: Obsessive cleanliness, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 554461c 012/134: Added toggle-hide-modeline, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti f213afd 017/134: Added safe-width fun, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 906974e 031/134: Fixes #5, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 30b82ff 018/134: Made body-width buffer-local, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti e0dabc0 024/134: Obsessive cleanliness, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 4252fe4 026/134: Deleted unneeded .gitignore, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti b42eb3e 029/134: Allow set-width to accept any number, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 34b8a54 032/134: Added doc string, Stefan Monnier, 2019/04/25