README: Add a simple file explaining notmuch and pointing out resources.
[notmuch] / README
1 Notmuch - thread-based email index, search and tagging.
2
3 Notmuch is a system for indexing, searching, reading, and tagging
4 large collections of email messages. It uses the Xapian library to
5 provide fast, full-text search of very large collection of email with
6 a very convenient search syntas.
7
8 Notmuch is free software, released under the GNU General Public
9 License version 3 (or later).
10
11 Building notmuch
12 ----------------
13 See the INSTALL file for notes on compiling and installing notmuch.
14
15 Contacting users and developers
16 -------------------------------
17 The website for Notmuch is:
18
19         http://notmuchmail.org
20
21 We will soon be creating a mailing list for users and developers of
22 notmuch. Details will appear on the website. Until then, please feel
23 free to email Carl with any questions you have:
24
25         Carl Worth <cworth@cworth.org>
26
27 There is also an IRC channel dedicated to talk about using and
28 developing notmuch:
29
30         IRC server:     irc.freenode.net
31         Channel:        #notmuch
32
33 Interface options
34 -----------------
35 Notmuch includes a "notmuch" command-line interface to the system.
36 This is not a very convenient interface and it is not expected that
37 users will find it satisfying. Instead, there are two option for
38 obtaining a more sophisticated interface:
39
40      1. Build on top of the "notmuch" command-line interface.
41
42         This might be a reasonable option for a very text-oriented
43         client environment. For example, an emacs-based interface for
44         notmuch is already under development and is available in the
45         notmuch.el file in this distribution.
46
47         If someone were to write a curses-based interface, or similar,
48         it might also be reasonable to buil on the "notmuch"
49         command-line interface.
50
51      2. Build on top of the notmuch library interface.
52
53         This is a better choice for developing an interface that has
54         full control of the presentation of email threads and
55         messages. It is expected that anyone integrating Notmuch into
56         an existing, graphical email program use the notmuch library
57         interface.
58
59         The public interface to the notmuch library is contained in
60         the notmuch.h header file. The "notmuch" command-line program
61         in notmuch.c can be used as good example code, since it is a
62         simple program that is written on top of the library
63         interface.
64
65 As can be seen, alternate interfaces to the Notmuch mail system are
66 still in development. We would appreciate any contributions to these
67 efforts.
68
69
70