larstvei/Focus
1
0
Fork 0
mirror of https://github.com/larstvei/Focus.git synced 2024-11-26 11:38:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added section on `focus-read-only-mode' in README

Browse Source
This commit is contained in:
Lars Tveito 2015-05-24 03:03:42 +02:00
parent fe94e0de69
commit 6b9620a73d
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -13,7 +13,20 @@ The package has only been tried on Emacs 24.4 and 24.5, but should work on Emacs
## Usage ## Usage
Enable the mode with <kbd> M-x focus-mode </kbd>. 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.
Some bindings are provided for simple navigation and exiting `focus-read-only-mode`.
Keybinding | Description
-------------------|----------------------------
<kbd> n </kbd> | Jump to next *thing*
<kbd> SPC </kbd> | Jump to next *thing*
<kbd> p </kbd> | Jump to previous *thing*
<kbd> S-SPC </kbd> | Jump to previous *thing*
<kbd> i </kbd> | Exit `focus-read-only-mode`
<kbd> q </kbd> | Exit `focus-read-only-mode`
### Example ### Example