branch: externals/consult-recoll
commit d550a76ffb00846a1b91be595e5adf5b9b2b1f93
Author: jao <j...@gnu.org>
Commit: jao <j...@gnu.org>
a bit more structure
---
readme.org | 32 +++++++++++++++++++-------------
1 file changed, 19 insertions(+), 13 deletions(-)
diff --git a/readme.org b/readme.org
index 2bc3d744b9..b5082919b8 100644
--- a/readme.org
+++ b/readme.org
@@ -1,5 +1,7 @@
#+title: consult-recoll
+* About
+
[[https://www.lesbonscomptes.com/recoll/][Recoll]] queries in emacs using
[[https://github.com/minad/consult][consult]].
This package requires a working recoll index, and ~recollq~ in your
@@ -10,21 +12,25 @@ path.
- See also the associated customization group for ways to tweak the
command's behaviour (e.g., how the selected candidate is visited).
-*** Tips
-***** Two-level filtering
+* Tips
+*** Two-level filtering
- ~consult-recoll~ builds on the asychronous logic inside =consult.el=,
- so you can use consult's handy
[[https://github.com/minad/consult#asynchronous-search][two-level filtering]],
which allows
- searching over the results of a query. For example, if you start
- typing
+ ~consult-recoll~ builds on the asychronous logic inside =consult.el=,
+ so you can use consult's handy
[[https://github.com/minad/consult#asynchronous-search][two-level filtering]],
which allows
+ searching over the results of a query. For example, if you start
+ typing
- #goedel's theorem
+ #+begin_example
+ #goedel's theorem
+ #+end_example
- see a bunch of results, and want to narrow them to those lines
- matching, say, "hofstadter", you can type ~#~ (which stops further
- recoll queries) followed by the term you're interested in:
+ see a bunch of results, and want to narrow them to those lines
+ matching, say, "hofstadter", you can type ~#~ (which stops further
+ recoll queries) followed by the term you're interested in:
- #goedel's theorem#hofstadter
+ #+begin_example
+ #goedel's theorem#hofstadter
+ #+end_example
- at which point only matches containing "hofstadter" will be
- offered.
+ at which point only matches containing "hofstadter" will be
+ offered.
