branch: externals/xeft
commit dd14e6993997b5322cbe19864147553b3bc3a9b6
Author: Yuan Fu <caso...@gmail.com>
Commit: Yuan Fu <caso...@gmail.com>
* README.md: Remove text about the dynamic mocule.
---
README.md | 53 ++++-------------------------------------------------
1 file changed, 4 insertions(+), 49 deletions(-)
diff --git a/README.md b/README.md
index 36e16358b5..3cf2e067a5 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,5 @@
-# What is Xeft
-
-1. A dynamic module that exposes a very basic indexing feature to
- Emacs Lisp, that lets you index and search a text files very fast.
-
-```emacs-lisp
-;; Querying my ~40MB worth of notes.
-(benchmark-run 100 (xeft-query-term "common lisp" xeft-database 0 10))
-;;=> (0.031512 0 0.0)
-```
-
-2. A note taking interface like Deft, built on top of the dynamic module.
-
# Usage
To use Xeft the note searching interface, install it and type `M-x
@@ -31,7 +18,7 @@ Directory `xeft-directory` stores note files, directory
with `xeft-ignore-extension`.
By default, Xeft only searches for first level files in
-`xeft-directory`, to make it search recursively, set `xeft-recursiv`
+`xeft-directory`, to make it search recursively, set `xeft-recursive`
to t.
See the “xeft” customize group for more custom options and faces.
@@ -55,46 +42,14 @@ Here `/opt/local` is the default prefix of macports, which
is what I
used to install Xapian. Homebrew and Linux users probably can leave it
empty.
-# Beware
-
-Since its a dynamic module, if Xeft goes wrong, it will crash Emacs.
-
# notdeft
-Many thanks to the author of notdeft. I don’t really know C++ or
+I owe many thanks to the author of notdeft. I don’t really know C++ or
Xapian, without reading his code I wouldn’t be able to write Xeft.
Also, if you want a more powerful searching experience, you will be
happier using notdeft instead.
-# How to use the dynamic module
-
-Because it’s so basic, the dynamic module is very easy to use and
-also very flexible. To index files, use
-
-```emacs-lisp
-(dolist (file (directory-files "my-note-dir"))
- (xeft-reindex-file file dbpath))
-```
-
-This indexes each file in `my-note-dir`, saving them to the database
-at `dbpath`. If the database doesn’t exist yet, it is created.
-
-To search for a term, use
-
-```emacs-lisp
-(xeft-query-term "search term" dbpath 0 10)
-```
-
-This returns a list of paths of the files that contains `search term`,
-ranked by relevance. The `0` and `10` means “return 10 results
-starting from the 0th place”, it is essentially used for paging. If
-you want all the result, use `0` and `999999`.
-
-When a file is modified, call `xeft-reindex-file` again on that file.
-If a file is removed, you don’t need to remove it from the database,
-it will be automatically removed. If the file has been indexed and
-haven’t been modified, `xeft-reindex-file` is (kind of) a no-op (i.e.
-fast).
+# Xapian dynamic module
-Both file path and database path must be absolute path.
+I wrote a xapian dynamic module that you can use too. Check it out at
<https://github.com/casouri/xapian-lite>.
