branch: externals/olivetti
commit cfd5ba91e838bd7ea8538826aaaacc39d919cb6a
Author: Paul W. Rankin <he...@paulwrankin.com>
Commit: Paul W. Rankin <he...@paulwrankin.com>
Update README/Commentary to reflect MELPA -> GNU ELPA
---
README.md | 35 +++++++----------------------------
olivetti.el | 54 +++++++++++++++++-------------------------------------
2 files changed, 24 insertions(+), 65 deletions(-)
diff --git a/README.md b/README.md
index 7ebd307..9519882 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,6 @@
Olivetti
========
-[](https://stable.melpa.org/#/olivetti)
-[](https://melpa.org/#/olivetti)
-
Olivetti is a simple Emacs minor mode for a nice writing environment.
@@ -46,35 +43,17 @@ Requirements
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`.
+Olivetti is now part of GNU ELPA and can be installed with `M-x package-install
+RET olivetti RET`.
-[melpa]: https://melpa.org/ "MELPA"
-[melpa-stable]: https://stable.melpa.org/ "MELPA Stable"
-[latest release]: https://github.com/rnkn/olivetti/releases/latest "Olivetti
latest release"
+Bugs
+----
-Known Bugs
-----------
-
-- Emacs 27.x currently has a bug in `window.c` that will cause errors in
+- Emacs 27.x has a compatibility change in `window.c` that will cause errors in
redisplay by passing a window instead of a frame as argument.
-- `linum-mode` in Emacs versions earlier than 26.1 has a bug that overwrites
- margin settings, making it incompatible with modes that work with margins.
- More information here: <https://debbugs.gnu.org/20674>.
-
-Please report bugs on GitHub [Issues] page.
-
-[issues]: https://github.com/rnkn/olivetti/issues "Olivetti issues"
-
-History
--------
-
-See [Releases].
-[releases]: https://github.com/rnkn/olivetti/releases "Olivetti releases"
+To report bugs, please use `M-x report-emacs-bug RET` or send an email to
+<bug-gnu-em...@gnu.org>
Hints
-----
diff --git a/olivetti.el b/olivetti.el
index 5b2f76a..3cdd4a9 100644
--- a/olivetti.el
+++ b/olivetti.el
@@ -34,21 +34,19 @@
;; - 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
+;; `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
+;; - 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
;; ------------
@@ -58,45 +56,27 @@
;; 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`.
+;; Olivetti is now part of GNU ELPA and can be installed with M-x
package-install
+;; RET olivetti RET.
-;; [melpa]: https://melpa.org/ "MELPA"
-;; [melpa-stable]: https://stable.melpa.org/ "MELPA Stable"
-;; [latest release]: https://github.com/rnkn/olivetti/releases/latest
"Olivetti latest release"
+;; Bugs
+;; ----
-;; Known Bugs
-;; ----------
-
-;; - Emacs 27.x currently has a bug in `window.c` that will cause errors in
+;; - Emacs 27.x has a compatibility change in window.c that will cause errors
in
;; redisplay by passing a window instead of a frame as argument.
-;; - `linum-mode` in Emacs versions earlier than 26.1 has a bug that overwrites
-;; margin settings, making it incompatible with modes that work with margins.
-;; More information here: <https://debbugs.gnu.org/20674>.
-
-;; Please report bugs on GitHub [Issues] page.
-
-;; [issues]: https://github.com/rnkn/olivetti/issues "Olivetti issues"
-
-;; History
-;; -------
-
-;; See [Releases].
-;; [releases]: https://github.com/rnkn/olivetti/releases "Olivetti releases"
+;; To report bugs, please use `M-x report-emacs-bug RET` or send an email to
+;; <bug-gnu-em...@gnu.org>
;; 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
+;; specifying `olivetti-body-width':
-;; 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
-;; [file variable]:
https://www.gnu.org/software/emacs/manual/html_node/emacs/File-Variables.html
"File Variables"
+;; See (info "(emacs) File Variables").
;;; Code:
