emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/focus 1c664fb992 17/82: Added installation section


From: ELPA Syncer
Subject: [nongnu] elpa/focus 1c664fb992 17/82: Added installation section
Date: Tue, 6 Sep 2022 04:58:55 -0400 (EDT)

branch: elpa/focus
commit 1c664fb992cba74d94370722f41b45e054d4e6af
Author: Lars Tveito <larstvei@ifi.uio.no>
Commit: Lars Tveito <larstvei@ifi.uio.no>

    Added installation section
---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index 7f503ef8af..08167dfb88 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 <kbd> M-x focus-mode </kbd>.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]