]> git.cworth.org Git - notmuch-wiki/blobdiff - index.mdwn
Add an introductory paragraph to the top-level of the website.
[notmuch-wiki] / index.mdwn
index e8bd06b5c1796c07d0c393ad549c50b614989e59..ebc2ba04a2c5a7761a74593f7b2c8e18ee9f29bf 100644 (file)
@@ -1,5 +1,11 @@
 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
-# Notmuch -- The mail indexer
+# Notmuch -- Just an email system
+
+Nomcuh is an email sytem that provides fast, global search of a local
+email store. It provides command-line access for easy scripting, as
+well as full-featured interfaces within consoles (or within text
+editors such as emacs). It also provides a clean, library-interface in
+C so that its functionality could be added to existing email programs.
 
 ## Why Notmuch?
 
@@ -16,7 +22,7 @@ Because dealing with your mail can be so much better.
   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](http://sup.rubyforge.org/).
+* Notmuch is an answer to [Sup](http://supmua.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
@@ -56,12 +62,14 @@ the initial indexing.  After that, come back and checkout our docs:
 
   * [[Notmuch manual pages|manpages]]
   * [[General how-tos|howto]]
+  * [[Frequently Asked Questions|faq]]
   * [[Searching]]
   * [[Excluding and deleting messages|excluding]]
   * [[Initial tagging|Initial_Tagging]]
   * [[Tips for using notmuch within Emacs|emacstips]]
   * [[Remote usage|remoteusage]]
   * [[Performance|performance]]
+  * [[References|references]]
 
 Apart from the wiki, help is available via email and on IRC (see
 below).  Join the mailing list.  Read the archives.  Ask questions.
@@ -73,24 +81,31 @@ Notmuch ships with a powerful set of [[command-line tools|manpages]], an
 [client for vim](http://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README),
 and a [[Mutt integration script|notmuch-mutt]].
 
-There are also other many other [[email clients and frontends|frontends]] based
-on Notmuch.
+There are also many other [[email clients and frontends|frontends]] based on
+Notmuch. And a few tips about integrating it with [[Mutt|mutttips]] and [[Vim|vimtips]].
 
 ## Screenshots
 
 * [[Emacs UI screenshots|screenshots]]
 
-## Packages
+## Obtaining Notmuch
+
+[Notmuch source releases](http://notmuchmail.org/releases/) are available as
+source tar balls.
+
+Notmuch is packaged for at least the following distributions:
 
+* [Arch Linux](https://www.archlinux.org/packages/?q=notmuch)
 * [Debian](http://packages.debian.org/search?keywords=notmuch)
-- Please use at least the packages from squeeze-backports, squeeze
-  packages are very outdated!
-* [Fedora](https://community.dev.fedoraproject.org/packages/notmuch)
+* [Fedora](https://apps.fedoraproject.org/packages/notmuch)
 * [Gentoo](http://packages.gentoo.org/package/net-mail/notmuch)
+* [openSUSE](https://build.opensuse.org/search?search_text=notmuch)
 * [Slackware](http://slackbuilds.org/repository/13.37/office/notmuch/)
 * [Ubuntu](http://packages.ubuntu.com/search?keywords=notmuch)
 
-## Source code
+Notmuch can be installed on Mac OS X using [MacPorts](https://www.macports.org/ports.php?by=name&substr=notmuch).
+
+## Development and Contributing
 
 All of the code for Notmuch is available as [free
 software](http://www.fsf.org/licensing/essays/free-sw.html) released
@@ -107,24 +122,18 @@ finally, you can
 to watch every commit made to notmuch and the notmuchmail.org web
 site.
 
-Here are
-[source tar balls of notmuch releases](http://notmuchmail.org/releases/).
-
 We have a [buildbot](http://buildbot.notmuchmail.org/grid) (here's
 its
 [configuration](https://github.com/tomprince/buildbot-configs/tree/notmuch)).
 
-## Bug-tracking and patches
+Contributions, such as patches, to Notmuch are most welcome. Please refer to the
+[[guide to contributing|contributing]].
+
+## Troubleshooting and reporting bugs
 
-Patches are most welcome and should be sent to notmuch@notmuchmail.org.
-Please try to follow the [[patch submission guidelines|patchformatting]]
-when submitting patches.
+For hints about troubleshooting and bug reporting see [[bugs]].
 
-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).
+For a list of known bugs see the [[nmbug status page|http://nmbug.tethera.net/status/#Bugs]]
 
 ## Contact: Email & IRC
 
@@ -149,11 +158,13 @@ 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.
+If you have a feature idea/request, please send it to the
+[mailing list](http://notmuchmail.org/mailman/listinfo/notmuch). You
+don't have to be subscribed to send, although there might be a delay
+for non-subscribers.
 
 ## Website
 
 This wiki is maintained using [ikiwiki](http://ikiwiki.info). Here are
-[[instructions on how to edit the wiki|wikiwriteaccess]].
+[[instructions on how to edit the wiki|wikiwriteaccess]]. The wiki contents are
+mostly [[dual licensed under CC-BY-SA-3.0 and GPLv3+|COPYING]].