branch: externals/consult
commit 7f11bf456561ae83879cc003051a1fa0a77f7443
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
Simplify the README
---
README.org | 22 +++++++++-------------
1 file changed, 9 insertions(+), 13 deletions(-)
diff --git a/README.org b/README.org
index 0fcdd81..fdc3421 100644
--- a/README.org
+++ b/README.org
@@ -251,18 +251,14 @@ their descriptions.
character is a punctuation character, like =#=. For example
=#grep-regexps#filter-string=, is split at the second =#=. The string
=grep-regexps= is passed to Grep. If you enter multiple regular expressions
- separated by space only lines matching all regular expressions are shown. If
- the grep program has support for Perl-compatible regular expressions (PCRE),
- then the regular expressions can appear in any order. If not, the regular
- expressions must appear in the input order. In this case, spaces are
- essentially replaced by ~.*~. The =filter-string= is passed to the /fast/
Emacs
- filtering to further narrow down the list of matches. This is particularly
- useful if you are using an advanced completion style like orderless.
- =consult-grep= supports preview. If the =consult-project-root-function= is
- [[#use-package-example][configured]] and returns non-nil, =consult-grep=
searches the current project
- directory. Otherwise the =default-directory= is searched. If =consult-grep=
is
- invoked with prefix argument =C-u M-s g=, you can specify the directory
- manually.
+ separated by space only lines matching all regular expressions are shown.
The
+ =filter-string= is passed to the /fast/ Emacs filtering to further narrow
down
+ the list of matches. This is particularly useful if you are using an
advanced
+ completion style like orderless. =consult-grep= supports preview. If the
+ =consult-project-root-function= is [[#use-package-example][configured]] and
returns non-nil, =consult-grep=
+ searches the current project directory. Otherwise the =default-directory= is
+ searched. If =consult-grep= is invoked with prefix argument =C-u M-s g=,
you can
+ specify the directory manually.
- =consult-find=, =consult-locate=: Find file by
matching the path against a regexp. Like for =consult-grep,= either the
project
root or the current directory is the root directory for the search. The
input
@@ -537,7 +533,7 @@ their descriptions.
Examples:
- =#defun=: Search for "defun" using grep.
- - =#consult embark=: Search for "consult" and "embark" using grep.
+ - =#consult embark=: Search for both "consult" and "embark" using grep.
- =#defun#consult=: Search for "defun" using grep, filter with the word
"consult".
- =/defun/consult=: It is also possible to use other punctuation
