X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=index.mdwn;h=aacdbf65db7ef0e2cc0326ac82f7c977fb922f30;hb=cb537693246b99ef999d3ae7c52051663b03d41f;hp=1bdee7f5d2ab69dbc3ecea971e63be70a4a5d758;hpb=4ba16353caf6a8f74797d5b342a65d8b545292eb;p=notmuch-wiki diff --git a/index.mdwn b/index.mdwn index 1bdee7f..aacdbf6 100644 --- a/index.mdwn +++ b/index.mdwn @@ -1,4 +1,7 @@ -# Why Notmuch? +[[!img notmuch-logo.png alt="Notmuch logo" class="left"]] +# Notmuch -- The mail indexer + +## Why Notmuch? * "Not much mail" is what Notmuch thinks about your email collection. Even if you receive 12000 messages per month or have on @@ -30,35 +33,80 @@ here? Not much. Notmuch is still in the early stages of development, but there are -already three user interfaces available for it (one for emacs, one for -vim, and another using curses for running within a terminal). 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. +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. 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. +## Documentation + +So far, there is not much documentation. Eventually, the wiki will +contain a reference for users. This is what we have so far: + +* [General how-tos](/howto) +* [Initial Tagging](/initial_tagging) +* [Emacstips](/emacstips) +* [Remote Usage](/remoteusage) + +Apart from the wiki, help is available via email. Join the mailing +list. Read the archives. Ask questions. + +## Source code + Either way, please feel free to jump in. All of the code for Notmuch is available as free -software released under the GNU GPL version 3. The latest versions +software released under the GNU +GPL version +3. The latest versions can be checked out via git with this command: - git clone git://notmuchmail.org/git/notmuch -Or you can browse the -Notmuch code history online. +You can browse the Notmuch code history +online. And finally, you can subscribe +to the notmuch-commits list 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/). + +## Contact: Email & IRC Comments? Please feel free to email the notmuch mailing list: notmuch@notmuchmail.org (subscription is not required, but you can -subscribe to -the notmuch list if you would like to). You can also browse the +subscribe to the [notmuch list](http://notmuchmail.org/mailman/listinfo/notmuch) if you would like to). You can also browse the online archives -or the mailing list or download an web forum (nabble), or download a mbox file of the entire mailing-list. + +The mb2md utility can be used to convert the archives to maildir format which is convenient for reading the archives within notmuch itself. + +If you prefer real-time chat, there is often someone on the [#notmuch](irc://chat.freenode.net/#notmuch)@irc.freenode.net IRC channel. + +## Feature ideas - bin list + +We have started a 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. + +## Emacs Tips and Tricks + +The best supported interface to notmuch is based on emacs and can be tweaked extensively. We have started to collect some tips and tricks [here](/emacstips). + +### Website + +This wiki is maintained using +[ikiwiki](http://ikiwiki.info). Instructions on how to edit it can be +found [here](/wikiwriteaccess).