[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/corfu-popup 6ef3a87d69 08/26: Add some screenshots
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/corfu-popup 6ef3a87d69 08/26: Add some screenshots |
Date: |
Sun, 22 May 2022 12:58:15 -0400 (EDT) |
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
- [nongnu] branch elpa/corfu-popup created (now 359e2e9849), ELPA Syncer, 2022/05/22
- [nongnu] elpa/corfu-popup 73db5e4484 02/26: Add COPYING, ELPA Syncer, 2022/05/22
- [nongnu] elpa/corfu-popup d46fe01493 05/26: Remove functions copied from Corfu, ELPA Syncer, 2022/05/22
- [nongnu] elpa/corfu-popup 6ef3a87d69 08/26: Add some screenshots,
ELPA Syncer <=
- [nongnu] elpa/corfu-popup aa0acdd12a 11/26: Clarify installation instructions, ELPA Syncer, 2022/05/22
- [nongnu] elpa/corfu-popup a52091075d 12/26: Fix typo, ELPA Syncer, 2022/05/22
- [nongnu] elpa/corfu-popup a75c704796 13/26: Add autoload cookie, ELPA Syncer, 2022/05/22
- [nongnu] elpa/corfu-popup cca92ac666 01/26: Working implementation, ELPA Syncer, 2022/05/22
- [nongnu] elpa/corfu-popup 2c789f87f3 04/26: Remove hardcoded file path, ELPA Syncer, 2022/05/22
- [nongnu] elpa/corfu-popup e5c7035190 06/26: Fix byte compilation error, ELPA Syncer, 2022/05/22
- [nongnu] elpa/corfu-popup 0effb93594 03/26: Fix typo, ELPA Syncer, 2022/05/22
- [nongnu] elpa/corfu-popup 3b649cce35 07/26: Patch out display-graphic-p call at compile time, ELPA Syncer, 2022/05/22
- [nongnu] elpa/corfu-popup 7a1fbd2676 09/26: Fix README, ELPA Syncer, 2022/05/22
- [nongnu] elpa/corfu-popup b2dd179e57 10/26: Fix typo, ELPA Syncer, 2022/05/22