[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/lin 466a4e8689 1/2: Add README.md as it previews better
From: |
ELPA Syncer |
Subject: |
[elpa] externals/lin 466a4e8689 1/2: Add README.md as it previews better on Git forges |
Date: |
Wed, 17 Jan 2024 00:58:55 -0500 (EST) |
branch: externals/lin
commit 466a4e8689ebd61dc8296b0d0f72082b7fc049d5
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
Add README.md as it previews better on Git forges
---
README.md | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..227b1f198c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Lin
+
+Lin is a stylistic enhancement for Emacs' built-in `hl-line-mode`. It
+remaps the `hl-line` face (or equivalent) buffer-locally to a style that
+is optimal for major modes where line selection is the primary mode of
+interaction.
+
+The idea is that `hl-line-mode` cannot work equally well for contexts
+with competing priorities: (i) line selection, or (ii) simple line
+highlight. In the former case, the current line needs to be made
+prominent because it carries a specific meaning of some significance in
+the given context: the user has to select a line. Whereas in the latter
+case, the primary mode of interaction does not revolve around the line
+highlight itself: it may be because the focus is on editing text or
+reading through the buffer's contents, so the current line highlight is
+more of a reminder of the point's location on the vertical axis.
+
++ Package name (GNU ELPA): `lin`
++ Official manual: <https://protesilaos.com/emacs/lin>
++ Change log: <https://protesilaos.com/emacs/lin-changelog>
++ Git repositories:
+ + GitHub: <https://github.com/protesilaos/lin>
+ + GitLab: <https://gitlab.com/protesilaos/lin>
++ Backronym: LIN Is Noticeable.