[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/logos 58e6b38384 2/3: Add README.md to make it easier f
From: |
ELPA Syncer |
Subject: |
[elpa] externals/logos 58e6b38384 2/3: Add README.md to make it easier for all Git forges |
Date: |
Sun, 26 Mar 2023 01:58:07 -0400 (EDT) |
branch: externals/logos
commit 58e6b383848424e8d2165a43a72509ab350a7ef7
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
Add README.md to make it easier for all Git forges
Thanks to Dave Abrahams for asking me to put a video demo in the
README. This inspired me to update this repository to be in the style
of the others I also maintain.
Dave's comment was made in issue 12 on the GitHub mirror:
<https://github.com/protesilaos/logos/issues/12>.
---
README.md | 20 ++++++++++++++++++++
README.org | 4 ++--
2 files changed, 22 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..68419f1a6c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Logos (logos.el)
+
+This package provides a simple approach to setting up a "focus mode"
+for Emacs. It uses the `page-delimiter` (typically the `^L`
+character) or the `outline-regexp` together with some commands to move
+between pages whether narrowing is in effect or not. It also provides
+some optional stylistic tweaks which come into effect when the
+buffer-local `logos-focus-mode` is enabled. The manual shows how to
+extend the code to achieve the desired result.
+
++ Package name (GNU ELPA): `logos`
++ Official manual: <https://protesilaos.com/emacs/logos>
++ Change log: <https://protesilaos.com/emacs/logos-changelog>
++ Git repo on SourceHut: <https://git.sr.ht/~protesilaos/logos>
+ - Mirrors:
+ + GitHub: <https://github.com/protesilaos/logos>
+ + GitLab: <https://gitlab.com/protesilaos/logos>
++ Mailing list: <https://lists.sr.ht/~protesilaos/logos>
++ Video demo: <https://protesilaos.com/codelog/2022-03-11-emacs-logos-demo/>
++ Backronyms: `^L` Only Generates Ostensible Slides; Logos Optionally Goes
through Outline Sections
diff --git a/README.org b/README.org
index b3863792e1..271e29abc2 100644
--- a/README.org
+++ b/README.org
@@ -623,8 +623,8 @@ Logos is meant to be a collective effort. Every bit of
help matters.
Omar AntolĂn Camarena, Philip Kaludercic, Remco van 't Veer, and user
Ypot.
-+ Ideas and/or user feedback :: Daniel Mendler, Marcel Ventosa,
- Xiaoduan, Ypot.
++ Ideas and/or user feedback :: Daniel Mendler, Dave Abrahams, Marcel
+ Ventosa, Xiaoduan, Ypot.
* GNU Free Documentation License
:PROPERTIES: