X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=index.mdwn;h=d7d519b0c71f140e627abe8794b1dc8724072cee;hb=f5ddc01eb0181124a8449a12afe2587e2304e6fb;hp=7bdcee627850a3df06fe169742b84ac7c48eedc3;hpb=60d0e619da1749b2bfba49cdcde0cfe228463181;p=notmuch-wiki diff --git a/index.mdwn b/index.mdwn index 7bdcee6..d7d519b 100644 --- a/index.mdwn +++ b/index.mdwn @@ -3,6 +3,8 @@ ## 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 @@ -25,23 +27,21 @@ 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. ## News @@ -49,19 +49,34 @@ you've been looking for. ## Documentation -So far, there is not much documentation. Eventually, the wiki will -contain a reference for users. This is what we have so far: +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]] - * [[Initial_Tagging]] + * [[Available frontends|frontends]] + * [[Searching]] + * [[Excluding and deleting messages|excluding]] + * [[Initial tagging|Initial_Tagging]] * [[Tips for using notmuch within Emacs|emacstips]] - * [[Remote Usage|remoteusage]] + * [[Remote usage|remoteusage]] * [[Performance|performance]] - * [[Available frontends|frontends]] 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 All of the code for Notmuch is available as [free @@ -70,7 +85,7 @@ 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, @@ -88,20 +103,13 @@ 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. -We are currently tracking patches with notmuch itself, using a utility -called [[nmbug]]. +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]]. -## 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/) - -## Screenshots - -* [[Emacs UI screenshots|screenshots]] - ## Contact: Email & IRC Comments? Please feel free to email the notmuch mailing list: