branch: externals/show-font
commit 66bb076f77347245890ae837c7c87c5728edfde6
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Update the README.md and include links to the manual and changelog
---
README.md | 19 +++++++++++--------
1 file changed, 11 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index aae615a2b9..29980a678d 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,19 @@
# show-font for GNU Emacs
-WORK-IN-PROGRESS.
-
DEMO HERE:
<https://protesilaos.com/codelog/2024-08-24-emacs-show-font-prototype/>.
-This package defines a major mode to preview a font in an Emacs
-buffer. A pangram and character set are displayed at varying heights
-to help the user appreciate the given font's features.
+This package lets you preview a font inside of Emacs. It does so in
+three ways:
+
+- Prompt for a font on the system and display it in a buffer.
+- List all known fonts in a buffer, with a short preview for each.
+- Provide a major mode to preview a font whose file is among the
+ installed ones.
-For the time being, this only works with fonts that are already
-installed on the system.
+## Sources
-+ Package name (GNU ELPA): `show-font` (⚠️ not available yet)
++ Package name (GNU ELPA): `show-font`
++ Official manual: <https://protesilaos.com/emacs/show-font>
++ Change log: <https://protesilaos.com/emacs/show-font-changelog>
+ Git repository: <https://github.com/protesilaos/show-font>
+ Backronym: Show How Outlines Will Feature Only in Non-TTY.
