[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/focus 563a3bd188 47/82: Updated README
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/focus 563a3bd188 47/82: Updated README |
Date: |
Tue, 6 Sep 2022 04:58:57 -0400 (EDT) |
branch: elpa/focus
commit 563a3bd188888b479cfdf5c20b6971895815e141
Author: Lars Tveito <larstvei@ifi.uio.no>
Commit: Lars Tveito <larstvei@ifi.uio.no>
Updated README
---
README.md | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index d68bb53cee..5d43da8588 100644
--- a/README.md
+++ b/README.md
@@ -15,9 +15,9 @@ The package has only been tried on Emacs 24.4 and 24.5, but
should work on Emacs
Enable the `focus-mode` with <kbd> M-x focus-mode </kbd>.
-Also, `focus-read-only-mode` is provided, which is optimized for continuous
reading. It inhibits change in the buffer, hides the cursor and provides
bindings for moving between *things* (defined in [Thing At
Point](http://emacswiki.org/emacs/ThingAtPoint). One can toggle
`focus-read-only-mode` with <kbd> M-x focus-read-only-mode </kbd> or <kbd> C-c
C-q </kbd> if `focus-mode` is enabled.
+Also, `focus-read-only-mode` is provided, which is a mode optimized for
continuous reading. It inhibits change in the buffer, hides the cursor and
provides bindings for moving between *things* (defined in [Thing At
Point](http://emacswiki.org/emacs/ThingAtPoint). One can toggle
`focus-read-only-mode` with <kbd> M-x focus-read-only-mode </kbd> or <kbd> C-c
C-q </kbd> if `focus-mode` is enabled.
-Some bindings are provided for simple navigation and exiting
`focus-read-only-mode`.
+Some bindings for simple navigation and exiting `focus-read-only-mode` are
provided.
Keybinding | Description
-------------------|----------------------------
@@ -28,6 +28,12 @@ Keybinding | Description
<kbd> i </kbd> | Exit `focus-read-only-mode`
<kbd> q </kbd> | Exit `focus-read-only-mode`
+## Configuring
+
+The amount of dimness can be customized by setting the `focus-dimness`
variable, where a positive integer indicates a more dim color (i.e. more
blended with the background color of your theme), and a negative integer
indicates a less dim color.
+
+Focus uses the [Thing At Point](http://emacswiki.org/emacs/ThingAtPoint)
library to choose what section should be in focus. By default, modes derived
from `prog-mode` uses `defun`, and modes derived from `text-mode` uses
`sentence`. This a customizable by setting the `focus-mode-to-thing` variable,
which is a list containing pairs on the form `(mode . thing)`.
+
### Example
This is what it looks like:
- [nongnu] elpa/focus 02cec3494d 01/82: Initial commit, (continued)
- [nongnu] elpa/focus 02cec3494d 01/82: Initial commit, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus e691113e4b 03/82: Moved init/termination to separate functions, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 284a1240ce 33/82: Cleaned up doc in `focus-average-colors', ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 58a91b29aa 34/82: Split focus-bounds into two functions, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus ac711fe13a 35/82: Whitespace cleanup, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 35f3cf5d52 20/82: Use things as defined in thingatpt as bounds, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 871f3c60ce 48/82: Fixed matching parenthesis, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus fe94e0de69 43/82: Split activation/deactivation into functions, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 2fbf024c53 79/82: Fix bug introduced in d5631db, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 6add57b887 59/82: Fix indentation, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 563a3bd188 47/82: Updated README,
ELPA Syncer <=
- [nongnu] elpa/focus d1bd81ee4d 39/82: Added focus-read-only-mode, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 4c8391ea32 29/82: Fixed bug in defgroup, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus b21341bd40 38/82: Added function for briefly showing the cursor, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 246eaeb8d1 72/82: Define faces for the unfocused and focused regions, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus b90cfb3c27 50/82: Fix #4, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus f590761dac 46/82: focus-read-only-mode calls for version bump, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 01a7a95334 27/82: Changed paragraph to section in README, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus cd2aad5590 31/82: Cleaned up focus-dimness docstring, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 5753e25fdf 30/82: fixed the focus-average-colors docstring, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus fee47bc7c9 11/82: Decrease the width of the gifs, ELPA Syncer, 2022/09/06