X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=README;h=5f029c828280f6661ea045d2a06496214686cc82;hb=7df0e611df9275bf2330bc73895e2d729a157adc;hp=9caf32dc84f5965f38e87fb11bea980e5e0b7fd4;hpb=2dd0cf8f5bbf63c0e0a423344de95e9d433bf7af;p=notmuch

diff --git a/README b/README
index 9caf32dc..5f029c82 100644
--- a/README
+++ b/README
@@ -1,54 +1,71 @@
-cnotmuch -- The python interface to notmuch.so
-==============================================
+Notmuch - thread-based email index, search and tagging.
 
-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.
+Notmuch is a system for indexing, searching, reading, and tagging
+large collections of email messages in maildir or mh format. It uses
+the Xapian library to provide fast, full-text search with a convenient
+search syntax.
 
-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:
+Notmuch is free software, released under the GNU General Public
+License version 3 (or later).
 
-`http://spaetz.bitbucket.org`_
+Building notmuch
+----------------
+See the INSTALL file for notes on compiling and installing notmuch.
 
-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).
+Contacting users and developers
+-------------------------------
+The website for Notmuch is:
 
-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.
+	http://notmuchmail.org
 
+The mailing list address for the notmuch community is:
 
-Usage
------
-For more examples of how to use the cnotmuch interface, have a look at the
-notmuch "binary" and the generated documentation.
+	notmuch@notmuchmail.org
 
-Example session:
->>>from cnotmuch import notmuch
->>>db = notmuch.Database("/home/spaetz/mail")
-db.get_path()
-'/home/spaetz/mail'
->>>tags = db.get_all_tags()
->>>for tag in tags: 
->>>  print tag
-inbox
-...
-maildir::draft
-#---------------------------------------------
+We welcome any sort of questions, comments, kudos, or code there.
 
-q = notmuch.Query(db,'from:Sebastian')
-count = len(q.search_messages())
-1300
+Subscription is not required, (but if you do subscribe you'll avoid
+any delay due to moderation). See the website for subscription
+information.
 
-#---------------------------------------------
+There is also an IRC channel dedicated to talk about using and
+developing notmuch:
 
->>>db = notmuch.Database("/home/spaetz/mailHAHA")
-NotmuchError: Could not open the specified database
+	IRC server:	irc.freenode.net
+	Channel:	#notmuch
 
-#---------------------------------------------
+Interface options
+-----------------
+Notmuch includes a "notmuch" command-line interface to the system.
+This is not a very convenient interface and it is not expected that
+users will find it satisfying. Instead, there are two option for
+obtaining a more sophisticated interface:
 
->>>tags = notmuch.Database("/home/spaetz/mail").get_all_tags()
->>>del(tags)
+     1. Build on top of the "notmuch" command-line interface.
+
+	This might be a reasonable option for a very text-oriented
+	client environment. For example, an emacs-based interface for
+	notmuch is already under development and is available in the
+	notmuch.el file in this distribution.
+
+	If someone were to write a curses-based interface, or similar,
+	it might also be reasonable to build on the "notmuch"
+	command-line interface.
+
+     2. Build on top of the notmuch library interface.
+
+	This is a better choice for developing an interface that has
+	full control of the presentation of email threads and
+	messages. It is expected that anyone integrating Notmuch into
+	an existing, graphical email program use the notmuch library
+	interface.
+
+	The public interface to the notmuch library is contained in
+	the notmuch.h header file. The "notmuch" command-line program
+	in notmuch.c can be used as good example code, since it is a
+	simple program that is written on top of the library
+	interface.
+
+As can be seen, alternate interfaces to the Notmuch mail system are
+still in development. We would appreciate any contributions to these
+efforts.