branch: externals/cursory
commit d4cfeb2170f2bae8f02d4be7c639ac02dc019166
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Make the package description a bit easier to read
---
README.md | 13 ++++++-------
README.org | 13 ++++++-------
cursory.el | 13 ++++++-------
3 files changed, 18 insertions(+), 21 deletions(-)
diff --git a/README.md b/README.md
index 41f8d05dae..eba9175325 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,11 @@
# Cursory for GNU Emacs
-Cursory provides a thin wrapper around built-in variables that affect
-the style of the Emacs cursor on graphical terminals. The intent is
-to allow the user to define preset configurations such as "block with
-slow blinking" or "bar with fast blinking" and set them on demand.
-The use-case for such presets is to adapt to evolving interface
-requirements and concomitant levels of expected comfort, such as in
-the difference between writing and reading.
+Cursory lets users define preset configurations for the cursor. Those
+cover the style of the cursor (e.g. box or bar), whether it is
+blinking or not, and how fast, as well as the colour it uses. Having
+distinct presets makes it easy to switch between, say, a "reading
+mode" with an ambient cursor and a "presentation mode" with a cursor
+that is more noticeable and thus easier to spot.
+ Package name (GNU ELPA): `cursory`
+ Official manual: <https://protesilaos.com/emacs/cursory>
diff --git a/README.org b/README.org
index 6e51c92856..c6a0b75951 100644
--- a/README.org
+++ b/README.org
@@ -190,13 +190,12 @@ Remember to read the doc string of each of these
variables or functions.
:CUSTOM_ID: h:5266a2c2-ae71-4018-b597-98952f46b81d
:END:
-Cursory provides a thin wrapper around built-in variables that affect
-the style of the Emacs cursor on graphical terminals. The intent is
-to allow the user to define preset configurations such as "block with
-slow blinking" or "bar with fast blinking" and set them on demand.
-The use-case for such presets is to adapt to evolving interface
-requirements and concomitant levels of expected comfort, such as in
-the difference between writing and reading.
+Cursory lets users define preset configurations for the cursor. Those
+cover the style of the cursor (e.g. box or bar), whether it is
+blinking or not, and how fast, as well as the colour it uses. Having
+distinct presets makes it easy to switch between, say, a "reading
+mode" with an ambient cursor and a "presentation mode" with a cursor
+that is more noticeable and thus easier to spot.
#+vindex: cursory-presets
#+findex: cursory-set-preset
diff --git a/cursory.el b/cursory.el
index 137cd8a338..dca236f903 100644
--- a/cursory.el
+++ b/cursory.el
@@ -26,13 +26,12 @@
;;; Commentary:
;;
-;; Cursory provides a thin wrapper around built-in variables that affect
-;; the style of the Emacs cursor on graphical terminals. The intent is
-;; to allow the user to define preset configurations such as "block with
-;; slow blinking" or "bar with fast blinking" and set them on demand.
-;; The use-case for such presets is to adapt to evolving interface
-;; requirements and concomitant levels of expected comfort, such as in
-;; the difference between writing and reading.
+;; Cursory lets users define preset configurations for the cursor.
+;; Those cover the style of the cursor (e.g. box or bar), whether it
+;; is blinking or not, and how fast, as well as the colour it uses.
+;; Having distinct presets makes it easy to switch between, say, a
+;; "reading mode" with an ambient cursor and a "presentation mode"
+;; with a cursor that is more noticeable and thus easier to spot.
;;
;; The user option `cursory-presets' holds the presets. The command
;; `cursory-set-preset' is applies one among them. The command supports
