X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=index.mdwn;h=578cb1834125dbb8746cf22633d11e43b06c932f;hb=7d4ba3c04557a156c3091239cb78271abb211e0a;hp=bb848d089f1f50f17381d842024e786f2f4175f4;hpb=8f142ee97479e41fe71cd40bfbc29de7610165bc;p=notmuch-wiki diff --git a/index.mdwn b/index.mdwn index bb848d0..578cb18 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,35 +42,61 @@ 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: + +* [[initialtagging|Initial Tagging]] +* [[emacstips|Emacs Tips]] + +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.madduck.net/project/notmuch) to help us keep track -of [the patches](http://patchwork.madduck.net/project/notmuch/list). +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. + +## 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). -This wiki is maintained used [ikiwiki](http://ikiwiki.info). You can pull and -push changes using the following URL (no authentication necessary): +### Website - git://notmuchmail.org/git/notmuch-wiki +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