From 1c664fb992cba74d94370722f41b45e054d4e6af Mon Sep 17 00:00:00 2001 From: Lars Tveito Date: Tue, 12 May 2015 23:31:54 +0200 Subject: [PATCH] Added installation section --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 7f503ef..08167df 100644 --- a/README.md +++ b/README.md @@ -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 M-x focus-mode .