branch: externals/vertico
commit 80a6df4896f50a47d5b4f543c89cdd80b61ea274
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
Add link to Corfu
---
README.org | 16 ++++++++++------
vertico.el | 10 +++++-----
2 files changed, 15 insertions(+), 11 deletions(-)
diff --git a/README.org b/README.org
index f20f7ee..611055d 100644
--- a/README.org
+++ b/README.org
@@ -10,11 +10,11 @@
* Introduction
-This package provides a minimalistic vertical completion UI, which is based on
-the default completion system. By reusing the default system, Vertico achieves
-full compatibility with built-in Emacs commands and completion tables. Vertico
-is pretty bare-bone and only provides a minimal set of commands. The code base
-is less than 500 lines of code. Additional optional enhancements can be
provided
+Vertico provides a minimalistic vertical completion UI, which is based on the
+default completion system. By reusing the default system, Vertico achieves full
+compatibility with built-in Emacs commands and completion tables. Vertico is
+pretty bare-bone and only provides a minimal set of commands. The code base is
+less than 500 lines of code. Additional optional enhancements can be provided
externally by complementary packages.
* Features
@@ -23,7 +23,7 @@ externally by complementary packages.
- Shows the index of the current candidate and the total number of candidates
- The current candidate is inserted with =TAB= and selected with =RET=
- Non-existing candidates are entered by moving the point to the prompt line
-- Candidates are sorted by history, string length and alphabetically
+- Candidates sorting by history, string length and alphabetically
- Long candidates with newlines are formatted to take up less space
- Support for ~annotation-function~, ~affixation-function~ and
~x-group-function~
@@ -143,6 +143,10 @@ completion UI. These packages are fully supported:
- [[https://github.com/oantolin/embark][Embark]]: Minibuffer actions and
context menu
- [[https://github.com/oantolin/orderless][Orderless]]: Advanced completion
style
+You may also want to look into my [[https://github.com/minad/corfu][Corfu]]
package, which provides a minimal
+completion system for completion-in-region using overlays. Corfu is developed
in
+the same spirit as Vertico.
+
* Alternatives
There are many alternative completion UIs, each UI with its own advantages and
diff --git a/vertico.el b/vertico.el
index f1c10f3..94d0853 100644
--- a/vertico.el
+++ b/vertico.el
@@ -26,11 +26,11 @@
;;; Commentary:
-;; This package provides a minimalistic vertical completion UI, which is based
-;; on the default completion system. By reusing the default system, Vertico
-;; achieve full compatibility with built-in Emacs commands and completion
-;; tables. Vertico is pretty bare-bone and only provides a minimal set of
-;; commands.
+;; Vertico provides a minimalistic vertical completion UI, which is
+;; based on the default completion system. By reusing the default
+;; system, Vertico achieve full compatibility with built-in Emacs
+;; commands and completion tables. Vertico is pretty bare-bone and
+;; only provides a minimal set of commands.
;;; Code:
