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

Added installation section

Browse Source
This commit is contained in:
Lars Tveito 2015-05-12 23:31:54 +02:00
parent e8c1eb5ce2
commit 1c664fb992
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -2,6 +2,29 @@
Focus provides `focus-mode` that dims the text of surrounding paragraphs, similar to [iA Writer's](https://ia.net/writer) Focus Mode.
## Installation
This package is still in development, so has not been submitted to
[Melpa](http://melpa.org/). This section will be simplified when (or if) the
package is added to Melpa.
The mode has only been tested with Emacs 24.4 and 24.5. It has no dependencies
other than `cl-lib` which is built in.
To install the Emacs extension just download the `focus.el`
```
git clone git@github.com:larstvei/Focus.git
```
and store `focus.el` it somewhere in your `load-path`. To use it you can put
```emacs-lisp
(require 'focus)
```
in you Emacs configuration file.
## Usage
Enable the mode with <kbd> M-x focus-mode </kbd>.