aboutsummaryrefslogtreecommitdiff
path: root/bindings/python/README
diff options
context:
space:
mode:
authorDavid Bremner <bremner@debian.org>2018-06-12 22:39:33 -0300
committerDavid Bremner <bremner@debian.org>2018-06-12 22:39:33 -0300
commit045f0e455ac94e2393d0d729c9bbdf3459a4860f (patch)
tree8d8b46ecba2c3c128365f16ece54377b987dbe58 /bindings/python/README
Import notmuch_0.27.orig.tar.gz
[dgit import orig notmuch_0.27.orig.tar.gz]
Diffstat (limited to 'bindings/python/README')
-rw-r--r--bindings/python/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/bindings/python/README b/bindings/python/README
new file mode 100644
index 00000000..5bf076d2
--- /dev/null
+++ b/bindings/python/README
@@ -0,0 +1,17 @@
+notmuch -- The python interface to notmuch
+==========================================
+
+This module makes the functionality of the notmuch library
+(`https://notmuchmail.org`_) available to python. Successful import of
+this module depends on a libnotmuch.so|dll being available on the
+user's system.
+
+If you have downloaded the full source tarball, you can create the
+documentation with sphinx installed, go to the docs directory and
+"make html". A static version of the documentation is available at:
+
+ https://notmuch.readthedocs.io/projects/notmuch-python/
+
+To build the python bindings, do
+
+ python setup.py install --prefix=path/to/your/preferred/location