[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/corfu bff11ca 04/29: Improve readme
From: |
Stefan Monnier |
Subject: |
[elpa] externals/corfu bff11ca 04/29: Improve readme |
Date: |
Fri, 16 Apr 2021 18:44:13 -0400 (EDT) |
branch: externals/corfu
commit bff11ca3a1a6ab5edabeb7fb396e4439c0d61539
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
Improve readme
---
README.org | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/README.org b/README.org
index 6bd0139..8f222db 100644
--- a/README.org
+++ b/README.org
@@ -14,28 +14,28 @@ point. Corfu can be considered the minimalistic
completion-in-region counterpart
of Vertico.
Icomplete provides both completion-in-region and minibuffer completion in a
-single package. While Corfu and Vertico are technically very similar to
-Icomplete, Corfu and Vertico are two separate packages in order to optimize the
-UI for the two distinct use cases, also leading to code bases which are easier
-to understand.
+single package. While Corfu and Vertico are technically similar to Icomplete,
+Corfu and Vertico are two separate packages in order to optimize the UI for the
+two distinct use cases, also leading to code bases which are easier to
+understand.
Corfu is a minimal package of less than 500 lines of code (my arbitrary limit
for small components providing a single specific feature). In contrast to the
-very featureful and complex Company package, Corfu only provides the completion
-UI. No custom backends are provided. Only ~completion-at-point-functions~ are
-supported. However many code completion backends provide
+featureful and complex Company package, Corfu only provides the completion
+UI. No custom backends are provided. The completions are provided by the
+~completion-at-point-functions~. However many code completion backends provide
~completion-at-point-functions~, such that relying only on the default
-completion is often sufficient.
+completion may often be sufficient.
[[https://github.com/minad/corfu/blob/main/screenshot.png?raw=true]]
* Features
-- Popup display with arrow key navigation
+- Popup display with scrollbar indicator and arrow key navigation
- The popup must be summoned explicitly by =TAB=
- The current candidate is inserted with =TAB= and selected with =RET=
- Candidates sorting by prefix, string length and alphabetically
-- Completion is automatically left, after a candidate has been selected.
+- Completion is automatically left after candidate selection
- Filter string can contain arbitrary characters and spaces (needed
when filtering with the [[https://github.com/oantolin/orderless][Orderless]]
completion style)
- [elpa] branch externals/corfu created (now a61992d), Stefan Monnier, 2021/04/16
- [elpa] externals/corfu 55d651e 03/29: Improve keybindings for active Corfu popup, Stefan Monnier, 2021/04/16
- [elpa] externals/corfu bff11ca 04/29: Improve readme,
Stefan Monnier <=
- [elpa] externals/corfu 15b0eee 05/29: Improve face definitions, Stefan Monnier, 2021/04/16
- [elpa] externals/corfu 3f930bc 06/29: Popup improvements/truncation, Stefan Monnier, 2021/04/16
- [elpa] externals/corfu bb55c62 01/29: initial commit, Stefan Monnier, 2021/04/16
- [elpa] externals/corfu 7d3c6c4 07/29: README: Update features section, Stefan Monnier, 2021/04/16
- [elpa] externals/corfu a2de3f2 11/29: Adjust faces, Stefan Monnier, 2021/04/16
- [elpa] externals/corfu 5571d2b 13/29: Revert "Go back to e0198b4335add183e0673c2b224e3d6c3ac09cab for now", Stefan Monnier, 2021/04/16
- [elpa] externals/corfu 4b32521 12/29: Go back to e0198b4335add183e0673c2b224e3d6c3ac09cab for now, Stefan Monnier, 2021/04/16
- [elpa] externals/corfu f721f1b 14/29: Properly compute character size, Stefan Monnier, 2021/04/16
- [elpa] externals/corfu 247c79b 16/29: update screenshot, Stefan Monnier, 2021/04/16
- [elpa] externals/corfu 428ef03 08/29: post-command-hook: Make the check more strict, Stefan Monnier, 2021/04/16