X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=index.mdwn;h=9cc052f32e4aa0a823271b1de44f8f8448da60c1;hb=5f5765ced6969050be63278f8dc77939571a2489;hp=c215a70c751c099ac0cfdc1615b4a4ca63c65b6b;hpb=a5b25a6c5fff843a940424f04a298d33ab563ce5;p=notmuch-wiki
diff --git a/index.mdwn b/index.mdwn
index c215a70..9cc052f 100644
--- a/index.mdwn
+++ b/index.mdwn
@@ -1,5 +1,7 @@
[[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
-# Why Notmuch?
+# 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
@@ -12,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 Sup.
+* 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
@@ -23,83 +25,114 @@
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. 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.
+ 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.
+## 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:
-* [[initialtagging|Initial Tagging]]
-* [[emacstips|Emacs Tips]]
+ * [[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 free
-software released under the GNU
-GPL version
-3. 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 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.
+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.
-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
+There is a buildbot [here](http://buildbot.notmuchmail.org/grid) (configuration [here](https://github.com/tomprince/buildbot-configs/tree/notmuch)).
-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](http://notmuchmail.org/mailman/listinfo/notmuch) if you would like to). You can also browse the
-online archives
-of the mailing list, read them as a web forum (nabble), or download a mbox file of the entire mailing-list.
+## Bug-tracking and patches
+
+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.
-The mb2md utility can be used to convert the archives to maildir format which is convenient for reading the archives within notmuch itself.
+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]].
-If you prefer real-time chat, there is often someone on the [#notmuch](irc://chat.freenode.net/#notmuch)@irc.freenode.net IRC channel.
+The status of current patches can also be followed [[online|http://nmbug.tethera.net/status]].
-## Emacs Tips and Tricks
+## Binary packages
-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).
+* [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/)
-### Website
+## Screenshots
-This wiki is maintained using [ikiwiki](http://ikiwiki.info). You can pull and
-push changes using the following URL (no authentication necessary):
+* [[Emacs UI screenshots|screenshots]]
- git://notmuchmail.org/git/notmuch-wiki
+## Contact: Email & IRC
-As the above is still broken, you will currently need to use [this](http://git.cworth.org/git/notmuch-wiki?a=commit;h=023952dcb7cbf5d4bd9c8ba2c79bac11d54af1d4), in order to change this site.
\ No newline at end of file
+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](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.
+
+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
+
+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
+
+This wiki is maintained using
+[ikiwiki](http://ikiwiki.info). Instructions on how to edit it can be
+found [[here|wikiwriteaccess]].