]> git.cworth.org Git - obsolete/notmuch-wiki/blobdiff - index.mdwn
Add description of tag notmuch::stale
[obsolete/notmuch-wiki] / index.mdwn
index 4716ce9c33b6c85c359b808fab68b3a5c4817a41..63fea85268a78406f467b17441bdd973f9ee340b 100644 (file)
@@ -14,7 +14,7 @@
   that you can keep your inbox tamed and focus on what really matters
   in your life, (which is surely not email).
 
-* Notmuch is an answer to <a href="http://sup.rubyforge.org/">Sup</a>.
+* Notmuch is an answer to [Sup](http://sup.rubyforge.org/).
   Sup is a very good email program written by William Morgan (and
   others) and is the direct inspiration for Notmuch. Notmuch began as
   an effort to rewrite performance-critical pieces of Sup in C rather
 * 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 network code at all). And for what it does do (email search) that
-  work is provided by an external library, <a
-  href="http://xapian.org/">Xapian</a>. So if Notmuch provides no user
+  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.  </ul>
+  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
@@ -43,69 +43,96 @@ 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
+
+[[The latest news from notmuch|news]]
+
 ## 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)
-* [Remote Usage](/remoteusage)
+  * [[General how-tos|howto]]
+  * [[Initial_Tagging]]
+  * [[Tips for using notmuch within Emacs|emacstips]]
+  * [[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.
 
 ## Source code
 
-Either way, please feel free to jump in. All of the code for Notmuch
-is available as <a
-href="http://www.fsf.org/licensing/essays/free-sw.html">free
-software</a> released under the GNU 
-<a href="http://www.fsf.org/licensing/licenses/gpl.html">GPL version 
-3</a>. The latest versions
-can be checked out via git with this command:
+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 <a
-href="http://git.notmuchmail.org/git/notmuch">Notmuch code history</a>
-online. And finally, you can <a
-href="http://notmuchmail.org/mailman/listinfo/notmuch-commits">subscribe
-to the notmuch-commits list</a> to watch every commit made to notmuch
-and the notmuchmail.org web site.
+You can browse the [Notmuch code
+history](http://git.notmuchmail.org/git/notmuch) online. And finally,
+you can [subscribe to the `notmuch-commits`
+list](http://notmuchmail.org/mailman/listinfo/notmuch-commits) to watch
+every commit made to notmuch and the notmuchmail.org web site.
+
+Source code of notmuch releases can be downloaded [here](http://notmuchmail.org/releases/).
+
+There is a buildbot [here](http://buildbot.notmuchmail.org/grid) (configuration [here](https://github.com/tomprince/buildbot-configs/tree/notmuch)).
+
+## Bug-tracking and patches
 
 Patches are most welcome and should be sent to notmuch&#64;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).
+Please try to follow the [[patch submission guidelines|patchformatting]]
+when submitting patches to notmuch.
 
-Source code of notmuch releases can be downloaded [here](http://notmuchmail.org/releases/).
+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:
 notmuch&#64;notmuchmail.org (subscription is not required, but you can
-subscribe to the [notmuch list](http://notmuchmail.org/mailman/listinfo/notmuch) if you would like to). You can also browse the
-<a href="http://notmuchmail.org/pipermail/notmuch/">online archives</a>
-of the mailing list, read them as a <a href="http://n3.nabble.com/notmuch-f198994.html">web forum (nabble)</a>, or download a <a href="http://notmuchmail.org/archives/notmuch.mbox">mbox file</a> 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.
+subscribe to the [notmuch
+list](http://notmuchmail.org/mailman/listinfo/notmuch) if you would
+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://notmuch.198994.n3.nabble.com/), or download an
+[mbox file](http://notmuchmail.org/archives/notmuch.mbox) of the entire
+mailing-list.
 
-## Feature ideas - bin list
+The `mb2md` utility can be used to convert the archives to maildir
+format which is convenient for reading the archives within notmuch
+itself.
 
-We have started a <a href="http://notmuchmail.org/feature-requests/">feature requests</a> page on this wiki. 
-No, things you add there won't automatically get implemented - but it's a nice way to collect ideas.
+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
+## Feature ideas
 
-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).
+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]].