X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=index.mdwn;h=ec381705102ef17a2fb89564088902bb3d5d936f;hb=ed1a219c82539da3768812731786d6b34e0ec3d5;hp=b5db4a3b7b29db3ce9a0bf1f32b5a77c4bf8147a;hpb=01e6cce55e03acbe707699797142ebfe228413c1;p=notmuch-wiki diff --git a/index.mdwn b/index.mdwn index b5db4a3..ec38170 100644 --- a/index.mdwn +++ b/index.mdwn @@ -1,3 +1,4 @@ +[[!img notmuch-logo.png alt="Notmuch logo" class="left"]] # Why Notmuch? * "Not much mail" is what Notmuch thinks about your email @@ -41,24 +42,66 @@ 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: + +* [Initial Tagging](/initial_tagging) +* [Emacstips](/emacstips) + +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). + +## 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 mbox file -of the entire mailing-list. The mb2md utility can then be used to -convert the archives to maildir format which is convenient for -reading the archives within notmuch itself. +of the mailing list, read them as a 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). \ No newline at end of file