summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Mendler <mail@daniel-mendler.de>2022-05-20 11:13:45 +0200
committerDaniel Mendler <mail@daniel-mendler.de>2022-05-20 11:13:45 +0200
commita2d843646fc30df2bea7b5cd3237ebf9269b2a01 (patch)
tree4a5b519dbbadb80f3f16d94e49ae4afa35b68a66
parentcf58c19598aee9828da49bdfb7d596208a91ccc9 (diff)
README update - Expand on corfu-terminal
-rw-r--r--README.org15
1 files changed, 9 insertions, 6 deletions
diff --git a/README.org b/README.org
index f706e10..d7bdad7 100644
--- a/README.org
+++ b/README.org
@@ -27,9 +27,9 @@ provided by other programming language packages are usually sufficient. A few
additional Capfs and completion utilities are provided by the [[https://github.com/minad/cape][Cape]] package.
*NOTE*: Corfu uses child frames to show the popup and falls back to the default
-setting of the ~completion-in-region-function~ on non-graphical displays. There is
-a [[https://codeberg.org/akib/emacs-corfu-popup][package in the works]] which uses overlays for the popup such that Corfu can be
-used when Emacs is running in a terminal.
+setting of the ~completion-in-region-function~ on non-graphical displays. If you
+want to use Corfu in the terminal, install the package [[https://codeberg.org/akib/emacs-corfu-terminal][corfu-terminal]], which
+provides an alternative overlay-based display.
[[https://github.com/minad/corfu/blob/screenshots/light.png?raw=true]]
@@ -422,6 +422,12 @@ Corfu works well together with all packages providing code completion via the
out of the box. Nevertheless you may want to look into complementary packages to
enhance your setup.
+- [[https://codeberg.org/akib/emacs-corfu-terminal][corfu-terminal]]: The corfu-terminal package provides an overlay-based display
+ for Corfu, such that you can use Corfu in terminal Emacs.
+
+- [[https://github.com/galeo/corfu-doc][corfu-doc]]: The corfu-doc package displays the candidate documentation in a
+ popup next to the Corfu popup, similar to =company-quickhelp=.
+
- [[https://github.com/oantolin/orderless][Orderless]]: Corfu supports completion styles, including the advanced
[[https://github.com/oantolin/orderless][Orderless]] completion style, where the filtering expressions are separated by
spaces or another character (see ~corfu-separator~).
@@ -437,9 +443,6 @@ enhance your setup.
the [[https://github.com/jdtsmith/kind-icon][kind-icon]] package provides beautifully styled SVG icons based on
monochromatic icon sets like material design.
-- [[https://github.com/galeo/corfu-doc][corfu-doc]]: The corfu-doc package displays the candidate documentation in a
- popup next to the Corfu popup, similar to =company-quickhelp=.
-
- [[https://github.com/JonWaltman/pcmpl-args.el][pcmpl-args]]: Extend the Eshell/Shell Pcomplete mechanism with support for many
more commands. Similar to the Fish shell, Pcomplete uses man page parsing to
dynamically retrieve the completions and helpful annotations. This package