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

Updated README

Browse Source
This commit is contained in:
Lars Tveito 2015-05-24 17:51:58 +02:00
parent f590761dac
commit 563a3bd188
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -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>. 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 Keybinding | Description
-------------------|---------------------------- -------------------|----------------------------
@ -28,6 +28,12 @@ Keybinding | Description
<kbd> i </kbd> | Exit `focus-read-only-mode` <kbd> i </kbd> | Exit `focus-read-only-mode`
<kbd> q </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 ### Example
This is what it looks like: This is what it looks like: