branch: externals/olivetti
commit b139a0a05df0e6604ff9ba7e6de57a1ab1e38152
Author: Paul W. Rankin <he...@paulwrankin.com>
Commit: Paul W. Rankin <he...@paulwrankin.com>
Update README/Commentary, deleted screenshot
---
README.md | 71 +++++++++++++++++++++--------------------------------
olivetti.el | 59 +++++++++++++++++++++-----------------------
screenshots/01.png | Bin 444294 -> 0 bytes
3 files changed, 56 insertions(+), 74 deletions(-)
diff --git a/README.md b/README.md
index c4969b6..84fdf0c 100644
--- a/README.md
+++ b/README.md
@@ -1,63 +1,48 @@
-Olivetti
-========
+# Olivetti #
-Olivetti is a simple Emacs minor mode for a nice writing environment.
+A simple Emacs minor mode for a nice writing environment.
-
+Screenshot: https://f002.backblazeb2.com/file/pwr-share/olivetti.png
-Pictured: *Big Fish* by John August using text body width of 66
-(top, also using [Fountain Mode]), lorem ipsum text using text body
-width of 80 (bottom)
+## Features ##
-[fountain mode]: https://github.com/rnkn/fountain-mode
-
-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).
-- Interactively change body width with:
- `olivetti-shrink` <kbd>C-c [</kbd> <kbd>[</kbd> <kbd>[</kbd> ...
- `olivetti-expand` <kbd>C-c ]</kbd> <kbd>]</kbd> <kbd>]</kbd> ...
- `olivetti-set-width` <kbd>C-c \ </kbd>
-- If `olivetti-body-width` is an integer, the text body width will scale
- with use of `text-scale-mode`, whereas if a fraction (float) then the
- text body width will remain at that fraction.
-- Optionally remember the state of `visual-line-mode` on entry and
- recall its state on exit.
+- 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-shrink C-c [ [ [ ...
+ olivetti-expand C-c ] ] ] ...
+ olivetti-set-width C-c \
+- If olivetti-body-width is an integer, the text body width will scale with
+ use of text-scale-mode, whereas if a fraction (float) then the text body
+ width will remain at that fraction.
+- Optionally remember the state of visual-line-mode on entry and recall its
+ state on exit.
Olivetti keeps everything it does buffer-local, so you can write prose in one
buffer and code in another, side-by-side in the same frame. For those looking
for a hardcore distraction-free writing mode with a much larger scope, I
-recommend [writeroom-mode][].
-
-[writeroom-mode]: https://github.com/joostkremers/writeroom-mode "Writeroom
Mode"
+recommend writeroom-mode: https://github.com/joostkremers/writeroom-mode.
-Requirements
-------------
+## Requirements ##
- Emacs 24.5
-Installation
-------------
+## Installation ##
-Olivetti is now part of GNU ELPA and can be installed with `M-x package-install
-RET olivetti RET`.
+Olivetti is now part of GNU ELPA and can be installed with:
+M-x package-install RET olivetti RET
-Bugs
-----
+## Contributing ##
-To report bugs, please use `M-x report-emacs-bug RET` or send an email to
+To report bugs, please use M-x report-emacs-bug RET or send an email to
<bug-gnu-em...@gnu.org>. Please include "olivetti" in the subject.
-Hints
------
+## Hints ##
-To always use a different width for a specific file, set a [File Variable]
-specifying `olivetti-body-width`:
+To always use a different width for a specific file, set a File Variable:
+M-x add-file-local-variable RET olivetti-body-width RET 66 RET
- M-x add-file-local-variable RET olivetti-body-width RET 66 RET
+See (info "(emacs) File Variables").
-[file variable]:
https://www.gnu.org/software/emacs/manual/html_node/emacs/File-Variables.html
"File Variables"
diff --git a/olivetti.el b/olivetti.el
index d7403ff..7c73582 100644
--- a/olivetti.el
+++ b/olivetti.el
@@ -2,7 +2,7 @@
;; Copyright (c) 2014-2019 Free Software Foundation, Inc.
-;; Author: Paul Rankin <he...@paulwrankin.com>
+;; Author: Paul W. Rankin <he...@paulwrankin.com>
;; Keywords: wp, text
;; Version: 1.7.1
;; Package-Requires: ((emacs "24.5"))
@@ -24,53 +24,50 @@
;;; Commentary:
-;; Olivetti is a simple Emacs minor mode for a nice writing environment.
+;; # Olivetti #
-;; Features
-;; --------
+;; A simple Emacs minor mode for a nice writing environment.
-;; - 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).
+;; Screenshot: https://f002.backblazeb2.com/file/pwr-share/olivetti.png
+
+;; ## 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).
;; - Interactively change body width with:
-;; `olivetti-shrink' C-c [ [ [ ...
-;; `olivetti-expand' C-c ] ] ] ...
-;; `olivetti-set-width' C-c \
-;; - If `olivetti-body-width' is an integer, the text body width will scale
-;; with use of `text-scale-mode`, whereas if a fraction (float) then the
-;; text body width will remain at that fraction.
-;; - Optionally remember the state of `visual-line-mode' on entry and
-;; recall its state on exit.
+;; olivetti-shrink C-c [ [ [ ...
+;; olivetti-expand C-c ] ] ] ...
+;; olivetti-set-width C-c \
+;; - If olivetti-body-width is an integer, the text body width will scale with
+;; use of text-scale-mode, whereas if a fraction (float) then the text body
+;; width will remain at that fraction.
+;; - Optionally remember the state of visual-line-mode on entry and recall its
+;; state on exit.
;; Olivetti keeps everything it does buffer-local, so you can write prose in
one
;; buffer and code in another, side-by-side in the same frame. For those
looking
;; for a hardcore distraction-free writing mode with a much larger scope, I
-;; recommend writeroom-mode: <https://github.com/joostkremers/writeroom-mode>.
+;; recommend writeroom-mode: https://github.com/joostkremers/writeroom-mode.
-;; Requirements
-;; ------------
+;; ## Requirements ##
;; - Emacs 24.5
-;; Installation
-;; ------------
+;; ## Installation ##
-;; Olivetti is now part of GNU ELPA and can be installed with M-x
package-install
-;; RET olivetti RET.
+;; Olivetti is now part of GNU ELPA and can be installed with:
+;; M-x package-install RET olivetti RET
-;; Bugs
-;; ----
+;; ## Contributing ##
-;; To report bugs, please use `M-x report-emacs-bug RET` or send an email to
+;; To report bugs, please use M-x report-emacs-bug RET or send an email to
;; <bug-gnu-em...@gnu.org>. Please include "olivetti" in the subject.
-;; Hints
-;; -----
-
-;; To always use a different width for a specific file, set a File Variable
-;; specifying `olivetti-body-width':
+;; ## Hints ##
+;; To always use a different width for a specific file, set a File Variable:
;; M-x add-file-local-variable RET olivetti-body-width RET 66 RET
;; See (info "(emacs) File Variables").
diff --git a/screenshots/01.png b/screenshots/01.png
deleted file mode 100644
index 45e09eb..0000000
Binary files a/screenshots/01.png and /dev/null differ
