Debian pkg creation stuff
[notmuch] / README
diff --git a/README b/README
index 14a35ae8449ea591a056eb8fba35ac62f1622b8b..fc5583149f7b2ae74ed74d96eb542fd92e4615f0 100644 (file)
--- a/README
+++ b/README
@@ -1,12 +1,46 @@
 cnotmuch -- The python interface to notmuch.so
 ==============================================
-To create the documentation with sphinx installed, go to the docs directory and
-"make html". A static version of the documentation is available at:
 
-http://spaetz.bitbucket.org
+This module makes the functionality of the notmuch library
+(`http://notmuchmail.org`_) available to python. Successful import of
+this modul depends on a libnotmuch.so|dll being available on the
+user's system.
 
+If you have downloaded the full source tarball (available from
+bitbucket.org, the source distribution and binary distribution come
+without the documentation), 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:
+
+http://packages.python.org/cnotmuch/
+
+The current source code is being hosted at
+http://bitbucket.org/spaetz/cnotmuch which also provides an issue
+tracker, and release downloads. This package is tracked by the python
+package index repository at `http://pypi.python.org/pypi/cnotmuch`_ and can thus be installed on a user's computer easily via "sudo easy_install cnotmuch" (you will still need to install the notmuch shared library separately as it is not included in this package).
+
+The original source has been provided by (c)Sebastian Spaeth, 2010.
 All code is available under the GNU GPLv3+ (see docs/COPYING) unless specified otherwise.
 
+
+INSTALLATION & DEINSTALL
+------------------------
+
+cnotmuch is available on pypi.python.org. This means you can do
+"easy_install cnotmuch" on your linux box and it will get installed
+into:
+
+/usr/local/lib/python2.x/dist-packages/
+
+For uninstalling, you'll need to remove the "cnotmuch-0.1-py2.x.egg"
+directory and delete one entry in the "easy-install.pth" file in that
+directory.
+
+It needs to have a libnotmuch.so or libnotmuch.so.1 available in some
+library folder or will raise an exception when loading.
+"OSError: libnotmuch.so.1: cannot open shared object file: No such file or directory"
+
+
 Usage
 -----
 For more examples of how to use the cnotmuch interface, have a look at the
@@ -38,3 +72,11 @@ NotmuchError: Could not open the specified database
 
 >>>tags = notmuch.Database("/home/spaetz/mail").get_all_tags()
 >>>del(tags)
+
+
+Changelog
+---------
+0.1   First public release
+0.1.1 Fixed Database.create_query()
+0.2.0 Implemented Thread() and Threads() methods
+0.2.1 Implemented the remaining API methods, notably Directory() and Filenames()
\ No newline at end of file