[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/vertico a68c51f1f3 5/5: README: Update quick start guid
From: |
ELPA Syncer |
Subject: |
[elpa] externals/vertico a68c51f1f3 5/5: README: Update quick start guide |
Date: |
Mon, 3 Jan 2022 11:57:47 -0500 (EST) |
branch: externals/vertico
commit a68c51f1f306ac9a6ac21411d8c288d30227acd4
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
README: Update quick start guide
---
README.org | 24 +++++++++++++-----------
1 file changed, 13 insertions(+), 11 deletions(-)
diff --git a/README.org b/README.org
index dffc5b3296..45f59aec6b 100644
--- a/README.org
+++ b/README.org
@@ -370,28 +370,30 @@ candidates from disappearing when they scroll off-screen
to the left.
- [[https://github.com/oantolin/orderless][Orderless]]: Advanced completion
style
In order to get accustomed with the package ecosystem, I recommed the
- following approach:
+ following quick start approach:
- 1. Start with plain Emacs.
+ 1. Start with plain Emacs (~emacs -Q~).
2. Install and enable Vertico to get incremental minibuffer completion.
3. Install Orderless and/or configure the built-in completion styles
for more flexible minibuffer filtering.
4. Install Marginalia if you like rich minibuffer annotations.
5. Install Embark and add two keybindings for ~embark-dwim~ and ~embark-act~.
- I am using =M-.= and =C-.=. These commands allow you to act on the object
- at point or in the minibuffer.
+ I am using the mnemonic keybindings =M-.= and =C-.= since these commands
allow
+ you to act on the object at point or in the minibuffer.
6. Install Consult if you want additional featureful completion commands,
e.g, the buffer switcher ~consult-buffer~ with preview or the line-based
search ~consult-line~.
7. Install Embark-Consult and Wgrep for export from =consult-line= to
=occur-mode=
buffers and from =consult-grep= to editable =grep-mode= buffers.
-
- You don't have to use all of these components. Use only the ones you like and
- the ones which fit well into your setup. The steps 1. to 4. introduce no new
- commands over plain Emacs. Step 5. introduces the new commands ~embark-act~
and
- ~embark-dwim~. In step 6. you get the Consult commands, some offer new
- functionality not present in Emacs already (e.g., ~consult-line~) and some
are
- substitutes (e.g., ~consult-buffer~ for ~switch-to-buffer~).
+ 8. Fine tune Vertico with [[#extensions][extensions]].
+
+ The ecosystem is modular. You don't have to use all of these components. Use
+ only the ones you like and the ones which fit well into your setup. The
+ steps 1. to 4. introduce no new commands over plain Emacs. Step 5. introduces
+ the new commands ~embark-act~ and ~embark-dwim~. In step 6. you get the
Consult
+ commands, some offer new functionality not present in Emacs already (e.g.,
+ ~consult-line~) and some are substitutes (e.g., ~consult-buffer~ for
+ ~switch-to-buffer~).
* Child frames and Popups