[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] master 0b7041e 22/34: More documentation
From: |
Artur Malabarba |
Subject: |
[elpa] master 0b7041e 22/34: More documentation |
Date: |
Fri, 16 Oct 2015 09:56:56 +0000 |
branch: master
commit 0b7041e1a22603d5f92463e8c53d05108c53efa3
Author: Artur Malabarba <address@hidden>
Commit: Artur Malabarba <address@hidden>
More documentation
---
Readme.org | 2 ++
beacon.el | 26 ++++++++++++++++++++++++--
2 files changed, 26 insertions(+), 2 deletions(-)
diff --git a/Readme.org b/Readme.org
index 011c8c1..cc9cd29 100644
--- a/Readme.org
+++ b/Readme.org
@@ -12,6 +12,8 @@ on top of your cursor so you know where it is.
That’s it.
+** Customizations
+
- To customize the appearance of the beacon, configure
~beacon-size~ and ~beacon-color~.
diff --git a/beacon.el b/beacon.el
index 149f6fb..8abafe2 100644
--- a/beacon.el
+++ b/beacon.el
@@ -23,8 +23,30 @@
;;; Commentary:
-;; This is a global minor-mode. Turn it on everywhere with
-;; (beacon-mode 1)
+;; This is a global minor-mode. Turn it on everywhere with:
+;; ┌────
+;; │ (beacon-mode 1)
+;; └────
+;;
+;; Whenever the window scrolls or the buffer changes a light will shine on
+;; top of your cursor so you know where it is.
+;;
+;; That’s it.
+;;
+;;
+;; 1 Customizations
+;; ════════════════
+;;
+;; • To customize the appearance of the beacon, configure `beacon-size'
+;; and `beacon-color'.
+;;
+;; • To customize how long it lasts, configure `beacon-blink-duration'
+;; and `beacon-blink-delay'.
+;;
+;; • To customize /when/ it is used at all, configure
+;; `beacon-blink-when-window-scrolls',
+;; `beacon-blink-when-buffer-changes', and
+;; `beacon-blink-when-point-moves'.
;;; Code:
- [elpa] master e533e04 11/34: Fix an error, (continued)
- [elpa] master e533e04 11/34: Fix an error, Artur Malabarba, 2015/10/16
- [elpa] master 03d12b4 03/34: Rename file, Artur Malabarba, 2015/10/16
- [elpa] master 8941740 07/34: Fix docs, Artur Malabarba, 2015/10/16
- [elpa] master c82095a 06/34: Add url, Artur Malabarba, 2015/10/16
- [elpa] master 9152a09 08/34: Separate mark-pushing from blinking, Artur Malabarba, 2015/10/16
- [elpa] master b60416c 01/34: First commit, Artur Malabarba, 2015/10/16
- [elpa] master ca3ec24 14/34: Fix temporary line breaks due to too long after-strings, Artur Malabarba, 2015/10/16
- [elpa] master c507480 13/34: Fix after-string overlays, Artur Malabarba, 2015/10/16
- [elpa] master 02112fa 12/34: Fix lighter, Artur Malabarba, 2015/10/16
- [elpa] master f1bb231 20/34: Fix scrolling outside command loop, Artur Malabarba, 2015/10/16
- [elpa] master 0b7041e 22/34: More documentation,
Artur Malabarba <=
- [elpa] master 5622af4 25/34: [#2] Add more options for preventing a blink, Artur Malabarba, 2015/10/16
- [elpa] master 6f647f6 21/34: Only blink selected window, Artur Malabarba, 2015/10/16
- [elpa] master 0036355 23/34: Copyright, Artur Malabarba, 2015/10/16
- [elpa] master bccd3de 33/34: Document contributors, Artur Malabarba, 2015/10/16
- [elpa] master d1f0728 26/34: Extend doc, Artur Malabarba, 2015/10/16
- [elpa] master 4a7079e 17/34: Improve readme, Artur Malabarba, 2015/10/16
- [elpa] master f439a41 27/34: Fix double blink when switching buffer, Artur Malabarba, 2015/10/16
- [elpa] master d66b206 28/34: Refactor overlay creation, Artur Malabarba, 2015/10/16
- [elpa] master b033c63 30/34: Merge pull request #6 from tsdh/master, Artur Malabarba, 2015/10/16
- [elpa] master 7294729 24/34: Don't blink on the minibuffer, Artur Malabarba, 2015/10/16