summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArun Isaac2020-02-15 20:12:57 +0530
committerArun Isaac2020-02-15 20:12:57 +0530
commitda4cc75ea4a137a899922294e62eeb019fd56992 (patch)
treead8268bf065aa4f326358f1b7354085fd64a79ca
parent184fc15152e938f82a1a15d7b3ce038132bf056d (diff)
downloadguile-xapian-da4cc75ea4a137a899922294e62eeb019fd56992.tar.gz
guile-xapian-da4cc75ea4a137a899922294e62eeb019fd56992.tar.lz
guile-xapian-da4cc75ea4a137a899922294e62eeb019fd56992.zip
README: Explain the end goal of Scheme-friendly wrapping.
* README.org: Explain the eventual complete wrapping of low level functions from (xapian wrap).
-rw-r--r--README.org5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.org b/README.org
index ca961d2..490b631 100644
--- a/README.org
+++ b/README.org
@@ -11,7 +11,10 @@ operators.
Once these bindings are sufficiently mature, they will be merged with
[[https://github.com/xapian/xapian/tree/master/xapian-bindings][xapian-bindings]]. This will involve creating more complete
Scheme-friendly wrapping of the Xapian library, writing test cases and
-documentation.
+documentation. When we are done, the user should not ever have to call
+the low level functions in (xapian wrap) and should be able to do
+almost everything using only the higher level Scheme-friendly
+functions in (xapian xapian).
There is no proper documentation yet. See the examples in the source
tree. Also see [[https://getting-started-with-xapian.readthedocs.io/en/latest/index.html][Getting Started with Xapian]] which describes the Python