emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/corfu 117d48a0be 4/6: README: Add separate installation


From: ELPA Syncer
Subject: [elpa] externals/corfu 117d48a0be 4/6: README: Add separate installation section
Date: Mon, 12 Feb 2024 18:57:42 -0500 (EST)

branch: externals/corfu
commit 117d48a0be87c9f7c0a6383225855b829bd450ef
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>

    README: Add separate installation section
---
 README.org | 24 ++++++++++++++----------
 1 file changed, 14 insertions(+), 10 deletions(-)

diff --git a/README.org b/README.org
index c47690e1bf..c81d6d0d49 100644
--- a/README.org
+++ b/README.org
@@ -63,6 +63,14 @@ provides an alternative overlay-based display.
 - Rich set of extensions: Quick keys, Index keys, Sorting by history, Candidate
   documentation in echo area, popup or separate buffer.
 
+* Installation
+
+Corfu is available from [[https://elpa.gnu.org/packages/corfu.html][GNU 
ELPA]]. You can install it directly via =M-x
+package-install RET corfu RET=. After installation, activate the global minor
+mode with =M-x global-corfu-mode RET=. Set the variable ~corfu-auto~ to t in 
order
+to enable auto completion. For manual completion press =M-TAB= (or =TAB=) 
within a
+buffer.
+
 * Key bindings
 
 Corfu uses a transient keymap ~corfu-map~ which is active while the popup is
@@ -87,17 +95,13 @@ bindings:
 | =C-g=                      | ~corfu-quit~               |
 | ~keyboard-escape-quit~     | ~corfu-reset~              |
 
-* Installation and Configuration
-
-Corfu is available from [[https://elpa.gnu.org/packages/corfu.html][GNU 
ELPA]], such that it can be installed directly via
-~package-install~. After installation, the global minor mode can be enabled 
with
-=M-x global-corfu-mode=. In order to configure Corfu and other packages in your
-init.el, you may want to use ~use-package~.
+* Configuration
 
-Corfu is highly flexible and customizable via ~corfu-*~ customization 
variables,
-such that you can adapt it precisely to your requirements. However in order to
-quickly try out the Corfu completion package, it should be sufficient to
-activate ~global-corfu-mode~. You can experiment with manual completion for
+In order to configure Corfu and other packages in your init.el, you may want to
+use ~use-package~. Corfu is flexibly customizable via ~corfu-*~ customization
+variables, such that you can adapt it precisely to your requirements. However 
in
+order to quickly try out the Corfu completion package, it should be sufficient
+to activate ~global-corfu-mode~. You can experiment with manual completion for
 example in an Elisp buffer or in an Eshell or Shell buffer. For auto 
completion,
 set ~corfu-auto~ to t before turning on ~global-corfu-mode~.
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]