Fix wrong-type-argument lisp error in `notmuch-fcc-header-setup'
[notmuch] / README
diff --git a/README b/README
index d7107b7d3ea008abf2806fcdcaa38ff479cd7711..3a003ad9cb7573d51879c945509da51ae8b2bd70 100644 (file)
--- a/README
+++ b/README
@@ -1,74 +1,77 @@
-cnotmuch -- The python interface to notmuch.so
-==============================================
-
-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://spaetz.bitbucket.org`_
-
-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).
+Notmuch - thread-based email index, search and tagging.
+
+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.
+
+Notmuch is free software, released under the GNU General Public
+License version 3 (or later).
+
+Building notmuch
+----------------
+See the INSTALL file for notes on compiling and installing notmuch.
+
+Running notmuch
+---------------
+After installing notmuch, start by running "notmuch setup" which will
+interactively prompt for configuration information such as your name,
+email address, and the directory which contains your mail archive to
+be indexed. You can change any answers later by running "notmuch
+setup" again or by editing the .notmuch-config file in your home
+directory.
 
-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.
+With notmuch configured you should next run "notmuch new" which will
+index all of your existing mail. This can take a long time, (several
+hours) if you have a lot of email, (hundreds of thousands of
+files). When new mail is delivered to your mail archive in the future,
+you will want to run "notmuch new" again. These runs will be much
+faster as they will only index new messages.
 
+Finally, you can prove to yourself that things are working by running
+some command-line searches such as "notmuch search
+from:someone@example.com" or "notmuch search subject:topic". See
+"notmuch help search-terms" for more details on the available search
+syntax.
 
-INSTALLATION & DEINSTALL
-------------------------
+The command-line search output is not expected to be particularly
+friendly for day-to-day usage. Instead, it is expected that you will
+use an email interface that builds on the notmuch command-line tool or
+the libnotmuch library.
 
-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:
+Notmuch installs a full-featured email interface for use within
+emacs. To use this, first add the following line to your .emacs file:
 
-/usr/local/lib/python2.x/dist-packages/
+       (require 'notmuch)
 
-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.
+Then, either run "emacs -f notmuch" or execute the command "M-x
+notmuch" from within a running emacs.
 
-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"
+If you're interested in a non-emacs-based interface to notmuch, then
+please join the notmuch community. Various other interfaces are
+already in progress, (an interface within vim, a curses interface,
+graphical interfaces based on evolution, and various web-based
+interfaces). The authors of these interfaces would love further
+testing or contribution. See contact information below.
 
+Contacting users and developers
+-------------------------------
+The website for Notmuch is:
 
-Usage
------
-For more examples of how to use the cnotmuch interface, have a look at the
-notmuch "binary" and the generated documentation.
+       http://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
-#---------------------------------------------
+The mailing list address for the notmuch community is:
 
-q = notmuch.Query(db,'from:Sebastian')
-count = len(q.search_messages())
-1300
+       notmuch@notmuchmail.org
 
-#---------------------------------------------
+We welcome any sort of questions, comments, kudos, or code there.
 
->>>db = notmuch.Database("/home/spaetz/mailHAHA")
-NotmuchError: Could not open the specified database
+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:
 
->>>tags = notmuch.Database("/home/spaetz/mail").get_all_tags()
->>>del(tags)
+       IRC server:     irc.freenode.net
+       Channel:        #notmuch