README: Tighten up the text a bit.
[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 with a convenient search syntax.
6
7 Notmuch is free software, released under the GNU General Public
8 License version 3 (or later).
9
10 Building notmuch
11 ----------------
12 See the INSTALL file for notes on compiling and installing notmuch.
13
14 Contacting users and developers
15 -------------------------------
16 The website for Notmuch is:
17
18         http://notmuchmail.org
19
20 The mailing list address for the notmuch community is:
21
22         notmuch@notmuchmail.org
23
24 We welcome any sort of questions, comments, kudos, or code there.
25
26 Subscription is not required, (but if you do subscribe you'll avoid
27 any delay due to moderation). See the website for subscription
28 information.
29
30 There is also an IRC channel dedicated to talk about using and
31 developing notmuch:
32
33         IRC server:     irc.freenode.net
34         Channel:        #notmuch
35
36 Interface options
37 -----------------
38 Notmuch includes a "notmuch" command-line interface to the system.
39 This is not a very convenient interface and it is not expected that
40 users will find it satisfying. Instead, there are two option for
41 obtaining a more sophisticated interface:
42
43      1. Build on top of the "notmuch" command-line interface.
44
45         This might be a reasonable option for a very text-oriented
46         client environment. For example, an emacs-based interface for
47         notmuch is already under development and is available in the
48         notmuch.el file in this distribution.
49
50         If someone were to write a curses-based interface, or similar,
51         it might also be reasonable to build on the "notmuch"
52         command-line interface.
53
54      2. Build on top of the notmuch library interface.
55
56         This is a better choice for developing an interface that has
57         full control of the presentation of email threads and
58         messages. It is expected that anyone integrating Notmuch into
59         an existing, graphical email program use the notmuch library
60         interface.
61
62         The public interface to the notmuch library is contained in
63         the notmuch.h header file. The "notmuch" command-line program
64         in notmuch.c can be used as good example code, since it is a
65         simple program that is written on top of the library
66         interface.
67
68 As can be seen, alternate interfaces to the Notmuch mail system are
69 still in development. We would appreciate any contributions to these
70 efforts.