## Why Notmuch?
+Because dealing with your mail can be so much better.
+
* "Not much mail" is what Notmuch thinks about your email
collection. Even if you receive 12000 messages per month or have on
the order of millions of messages that you've been saving for
features can be integrated into any email program.)
* Notmuch is not much of an email program. It doesn't receive messages
- (no POP or IMAP suport). It doesn't send messages (no mail composer,
+ (no POP or IMAP support). It doesn't send messages (no mail composer,
no network code at all). And for what it does do (email search) that
work is provided by an external library,
[Xapian](http://xapian.org). So if Notmuch provides no user
interface and Xapian does all the heavy lifting, then what's left
here? Not much.
-Notmuch is still in the early stages of development, but there are
-already two user interfaces available for it (one for emacs and one
-for vim). If you've been looking for a fast, global-search and
-tag-based email reader to use within your text editor or in a
-terminal, then Notmuch may be exactly what you've been looking for.
+If you've been looking for a fast, global-search and tag-based email
+reader to use within your text editor or in a terminal, then Notmuch
+may be exactly what you've been looking for.
-Otherwise, if you're a developer of an existing email program and
-would love a good library interface for fast, global search with
-support for arbitrary tags, then Notmuch also may be exactly what
-you've been looking for.
+If you're a developer of an existing email program and would love a
+good library interface for fast, global search with support for
+arbitrary tags, then Notmuch also may be exactly what you've been
+looking for.
-## Documentation
+## News
-So far, there is not much documentation. Eventually, the wiki will
-contain a reference for users. This is what we have so far:
+[[The latest news from notmuch|news]]
-* [General how-tos](/howto)
-* [Initial Tagging](/initial_tagging)
-* [Tips for using notmuch within Emacs](/emacstips)
-* [Remote Usage](/remoteusage)
+## Documentation
+
+To get started with notmuch, just run "notmuch" at the command line.
+The configuration wizard will walk you through initial setup,
+including specifying the location of your mail store and now to start
+the initial indexing. After that, come back and checkout how our
+docs:
+
+ * [[General how-tos|howto]]
+ * [[Available frontends|frontends]]
+ * [[Searching]]
+ * [[Excluding and deleting messages|excluding]]
+ * [[Initial tagging|Initial_Tagging]]
+ * [[Tips for using notmuch within Emacs|emacstips]]
+ * [[Remote usage|remoteusage]]
+ * [[Performance|performance]]
Apart from the wiki, help is available via email. Join the mailing
list. Read the archives. Ask questions.
+## Screenshots
+
+* [[Emacs UI screenshots|screenshots]]
+
+## Binary packages
+
+* [Debian](http://packages.debian.org/search?keywords=notmuch), [Ubuntu](http://packages.ubuntu.com/search?keywords=notmuch)
+* [Slackware](http://slackbuilds.org/repository/13.37/office/notmuch/)
+* [Fedora](https://community.dev.fedoraproject.org/packages/notmuch)
+
## Source code
-Either way, please feel free to jump in. All of the code for Notmuch
-is available as [free
+All of the code for Notmuch is available as [free
software](http://www.fsf.org/licensing/essays/free-sw.html) released
under the GNU [GPL version
3](http://www.fsf.org/licensing/licenses/gpl.html). The latest
versions can be checked out via git with this command:
- git clone git://notmuchmail.org/git/notmuch
+ git clone git://notmuchmail.org/git/notmuch
You can browse the [Notmuch code
history](http://git.notmuchmail.org/git/notmuch) online. And finally,
list](http://notmuchmail.org/mailman/listinfo/notmuch-commits) to watch
every commit made to notmuch and the notmuchmail.org web site.
-Patches are most welcome and should be sent to notmuch@notmuchmail.org.
-Please try to follow the [patch submission guidelines of the Git
-project](http://repo.or.cz/w/git.git?a=blob;f=Documentation/SubmittingPatches;hb=HEAD)
-when submitting patches to notmuch. We are currently test-driving a [Patchwork
-instance](http://patchwork.notmuchmail.org/project/notmuch) to help us keep track
-of [the patches](http://patchwork.notmuchmail.org/project/notmuch/list).
-
Source code of notmuch releases can be downloaded [here](http://notmuchmail.org/releases/).
-## Binary packages
+There is a buildbot [here](http://buildbot.notmuchmail.org/grid) (configuration [here](https://github.com/tomprince/buildbot-configs/tree/notmuch)).
-* [Debian](http://packages.debian.org/search?keywords=notmuch), [Ubuntu](http://packages.ubuntu.com/search?keywords=notmuch)
+## Bug-tracking and patches
-## Screenshots
+Patches are most welcome and should be sent to notmuch@notmuchmail.org.
+Please try to follow the [[patch submission guidelines|patchformatting]]
+when submitting patches to notmuch.
-* [[Emacs UI screenshots|screenshots]]
+The tagging and filtering features of notmuch make it quite suitable
+for use as a bug- and patch-tracker. We are currently experimenting
+with using it for this purpose for notmuch development, using a
+utility called [[nmbug]].
+
+The status of current patches can also be followed [[online|http://nmbug.tethera.net/status]].
## Contact: Email & IRC
like to). You can also browse the [online
archives](http://notmuchmail.org/pipermail/notmuch/) of the mailing
list, read them as a [web forum
-(nabble)](http://n3.nabble.com/notmuch-f198994.html), or download an
+(nabble)](http://notmuch.198994.n3.nabble.com/), or download an
[mbox file](http://notmuchmail.org/archives/notmuch.mbox) of the entire
mailing-list.
[#notmuch](irc://chat.freenode.net/#notmuch)@irc.freenode.net IRC
channel.
-## Feature Ideas
+## Feature ideas
-We have started a [feature requests](/feature-requests) page on this
+We have started a [[feature requests|feature-requests]] page on this
wiki. No, things you add there won't automatically get implemented -
but it's a nice way to collect ideas.
-### Website
+## Website
This wiki is maintained using
[ikiwiki](http://ikiwiki.info). Instructions on how to edit it can be
-found [here](/wikiwriteaccess).
+found [[here|wikiwriteaccess]].
projects / notmuch-wiki / blobdiff