[nongnu] elpa/corfu-popup 6ef3a87d69 08/26: Add some screenshots

[ELPA Syncer]

branch: elpa/corfu-popup
commit 6ef3a87d69c4258fa88794ff285e8130cc5f5552
Author: Akib Azmain Turja <akib@disroot.org>
Commit: Akib Azmain Turja <akib@disroot.org>

    Add some screenshots
---
 README.org         |  46 +++++++++++++++++++++++++++++++++++++++++++---
 demo-colorterm.png | Bin 0 -> 12510 bytes
 demo-gui.png       | Bin 0 -> 13163 bytes
 demo-tty.png       | Bin 0 -> 10686 bytes
 4 files changed, 43 insertions(+), 3 deletions(-)

diff --git a/README.org b/README.org
index 34d2d8d476..0e623f33d0 100644
--- a/README.org
+++ b/README.org
@@ -1,8 +1,48 @@
 #+title: ~corfu-popup~ - Corfu popup on terminal
 
-Corfu uses child frames to display candidates.  This makes Corfu
-unusable on terminal.  This package replaces that with popup/popon,
-which works everywhere.  Use M-x corfu-popup-mode to enable.  You'll
+Corfu uses child frames to display candidates.  This makes Corfu unusable
+on terminal.  This package replaces that with popup/popon, which works
+everywhere.
+
+| GUI            | Terminal (Colorterm) | TTY (with face customizations) |
+|----------------+----------------------+--------------------------------|
+| [[./demo-gui.png]] | [[./demo-colorterm.png]] | [[./demo-tty.png]]           
      |
+
+/Note: The above screenshots were taken with ~kind-icons~ enabled, which/
+/doesn't work well with overlays.  And the TTY screenshot isn't a/
+/screenshot of a real TTY, it was emulated on a terminal emulator/
+/with ~TERM=linux~ and ~COLORTERM=~, and the Corfu faces were modified to/
+/make the visible on TTY./
+
+* Installation
+
+~corfu-popup~ isn't available on any ELPA right now.  To install it, first
+install [[https://codeberg.org/akib/emacs-popon][Popon]] by following 
installation instructions of it, then do one of
+the following:
+
+** Quelpa
+
+#+begin_src emacs-lisp
+(quelpa '(corfu-popup
+          :fetcher git
+          :url "https://codeberg.org/akib/emacs-corfu-popup.git";))
+#+end_src
+
+** Straight.el
+
+#+begin_src emacs-lisp
+(straight-use-package
+ '(corfu-popup :type git
+               :repo "https://codeberg.org/akib/emacs-corfu-popup.git";))
+#+end_src
+
+** Manual
+
+Download the ~corfu-popup.el~ file and put it in your ~load-path~.
+
+* Usage
+
+Enable the global minor mode =M-x corfu-popup-mode= to enable it. You'll
 probably want to enable it only on terminal.  In that case, put the
 following in your init file:
 
diff --git a/demo-colorterm.png b/demo-colorterm.png
new file mode 100644
index 0000000000..fb79683f65
Binary files /dev/null and b/demo-colorterm.png differ
diff --git a/demo-gui.png b/demo-gui.png
new file mode 100644
index 0000000000..0744c3257d
Binary files /dev/null and b/demo-gui.png differ
diff --git a/demo-tty.png b/demo-tty.png
new file mode 100644
index 0000000000..e374b4b491
Binary files /dev/null and b/demo-tty.png differ