[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/olivetti 7bf367c 105/134: Updated README/Commentary
From: |
Stefan Monnier |
Subject: |
[elpa] externals/olivetti 7bf367c 105/134: Updated README/Commentary |
Date: |
Thu, 25 Apr 2019 09:57:38 -0400 (EDT) |
branch: externals/olivetti
commit 7bf367ccac5fc733801c9924ef6fcae6e2d01280
Author: Paul Rankin <address@hidden>
Commit: Paul Rankin <address@hidden>
Updated README/Commentary
- added more discussion about display-line-numbers-mode
- copied README to Commentary
---
README.md | 7 ++++---
olivetti.el | 26 +++++++++++++++++++++++---
2 files changed, 27 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 166a950..5404ea5 100644
--- a/README.md
+++ b/README.md
@@ -60,10 +60,11 @@ Alternately, download the [latest release] and put it in
your
Known Bugs
----------
-- `display-line-numbers-mode` (included in Emacs 26.1) has a poor
implementation
- that causes problems with modes that work with the text body width or
margins.
+- `display-line-numbers-mode` (included in Emacs 26.1) has a terrible
+ implementation that causes problems with many modes that work with display.
Discussion at <https://debbugs.gnu.org/28248> and
- <https://debbugs.gnu.org/28844>. Use `linum-mode` instead.
+ <https://debbugs.gnu.org/28844> and <http://debbugs.gnu.org/29597>. Use
+ `linum-mode` instead.
- `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>.
diff --git a/olivetti.el b/olivetti.el
index 51de127..62a4d1c 100644
--- a/olivetti.el
+++ b/olivetti.el
@@ -45,6 +45,15 @@
;; recall its state on exit.
;; - Optionally hide the mode-line for distraction-free writing.
+;; 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. Or, by hiding
the
+;; mode-line and using a single window in a fullscreen frame, Olivetti
provides a
+;; nice distraction-free environment. 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"
+
;; Requirements
;; ------------
@@ -66,10 +75,11 @@
;; Known Bugs
;; ----------
-;; - `display-line-numbers-mode` (included in Emacs 26.1) has a poor
implementation
-;; that causes problems with modes that work with the text body width or
margins.
+;; - `display-line-numbers-mode` (included in Emacs 26.1) has a terrible
+;; implementation that causes problems with many modes that work with
display.
;; Discussion at <https://debbugs.gnu.org/28248> and
-;; <https://debbugs.gnu.org/28844>. Use `linum-mode` instead.
+;; <https://debbugs.gnu.org/28844> and <http://debbugs.gnu.org/29597>. Use
+;; `linum-mode` instead.
;; - `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>.
@@ -85,6 +95,16 @@
;; [releases]: https://github.com/rnkn/olivetti/releases "Olivetti releases"
+;; Hints
+;; -----
+
+;; 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
+
+;; [file variable]:
https://www.gnu.org/software/emacs/manual/html_node/emacs/File-Variables.html
"File Variables"
+
;;; Code:
- [elpa] externals/olivetti 35d275d 104/134: deleted: TODO.md, (continued)
- [elpa] externals/olivetti 35d275d 104/134: deleted: TODO.md, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 38b2eb4 110/134: Limit window-width to 2* largest fringe, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 8558589 111/134: Rewrite olivetti-set-environment, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti ef3d85e 051/134: Updated copyright, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 4f9210b 074/134: Don't use min-margins - there is a better way, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 3f237b0 075/134: Use split-window window-parameter, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti e515385 083/134: Docstring update, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti de2716c 081/134: Only reset all windows on exit, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti fd5d85b 097/134: Enhance short description, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 85ecdfc 099/134: Revert "Enhance short description", Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 7bf367c 105/134: Updated README/Commentary,
Stefan Monnier <=
- [elpa] externals/olivetti 7eadbe7 108/134: Rewrite olivetti-safe-width for fringes, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti fc3b045 116/134: Readded window-configuration-change-hook, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti ff2b0a0 123/134: Change default body width to 70 (matches fill-column standard-value), Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti cb22f8a 127/134: Merge pull request #25 from Nielius/fix-scale-width, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 3859a4d 030/134: Added known bugs section to README/Commentary, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 16d0885 035/134: Fix "modeline" => "mode-line", Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 26e9da6 041/134: Use defvar-local, it's cleaner, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti d852e31 040/134: Merge pull request #8 from syohex/update-url, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti f629184 042/134: Merge branch 'master' of https://github.com/rnkn/olivetti, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 48874ef 045/134: Hiding mode-line seems to work without frame redrawing, Stefan Monnier, 2019/04/25