[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>.
- [nongnu] elpa/focus 90806dc7ea 18/82: Added custom variable for setting dimness, (continued)
- [nongnu] elpa/focus 90806dc7ea 18/82: Added custom variable for setting dimness, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 704db49988 82/82: Merge pull request #24 from phikal/master, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus c89d08f510 24/82: Applied purcell's recommendations, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 94ed8ab68b 36/82: Defined variables to help hide the cursor, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus e8c1eb5ce2 16/82: Added short commentary, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 75202c9445 58/82: Version bump, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 8028fc088f 04/82: Improved average color function, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus e9ab37b865 81/82: Improved user option types, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus aa5ea31118 65/82: Fixed package lint warnings., ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus a80b7b6eba 71/82: Add possibility of customizing the face of the focused region, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 1c664fb992 17/82: Added installation section,
ELPA Syncer <=
- [nongnu] elpa/focus bf5fcff0d0 69/82: Allow setting a color for dimmed text. Fixes #21, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus f310fa1c31 52/82: Split up `focus-move-focus', ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 5e483363ac 75/82: New README, ELPA Syncer, 2022/09/06
- [nongnu] elpa/focus 6b9620a73d 44/82: Added section on `focus-read-only-mode' in README, ELPA Syncer, 2022/09/06