]> git.cworth.org Git - notmuch-wiki/blobdiff - index.mdwn
update documentation for akonadi address completion
[notmuch-wiki] / index.mdwn
index 96b47334cbfa84272a52f49ea03abd87d2655ab3..96dc014f30cc6b107da39d8b55498b56c65c689a 100644 (file)
@@ -56,32 +56,50 @@ the initial indexing.  After that, come back and checkout our docs:
 
   * [[Notmuch manual pages|manpages]]
   * [[General how-tos|howto]]
 
   * [[Notmuch manual pages|manpages]]
   * [[General how-tos|howto]]
-  * [[Available frontends|frontends]]
+  * [[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]]
   * [[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.
 
 
 Apart from the wiki, help is available via email and on IRC (see
 below).  Join the mailing list.  Read the archives.  Ask questions.
 
+## Email clients and front ends
+
+Notmuch ships with a powerful set of [[command-line tools|manpages]], an
+[[email client for Emacs|emacstips]], another
+[client for vim](http://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README),
+and a [[Mutt integration script|notmuch-mutt]].
+
+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]]
 
 ## 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)
 * [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)
 * [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)
 
 * [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
 
 All of the code for Notmuch is available as [free
 software](http://www.fsf.org/licensing/essays/free-sw.html) released
@@ -98,25 +116,23 @@ finally, you can
 to watch every commit made to notmuch and the notmuchmail.org web
 site.
 
 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
 We have a [buildbot](http://buildbot.notmuchmail.org/grid) (here's
-it's
+its
 [configuration](https://github.com/tomprince/buildbot-configs/tree/notmuch)).
 
 [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]].
 
 
-Patches are most welcome and should be sent to notmuch@notmuchmail.org.
-Please try to follow the [[patch submission guidelines|patchformatting]]
-when submitting patches.
+## Bug and patch tracking
 
 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
 
 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
+utility called [[nmbug]]. The status of bugs and current patches can also be
 followed [online](http://nmbug.tethera.net/status).
 
 followed [online](http://nmbug.tethera.net/status).
 
+Bug reports should be sent to the Notmuch mailing list notmuch@notmuchmail.org.
+
 ## Contact: Email & IRC
 
 Comments? Please feel free to email the notmuch mailing list:
 ## Contact: Email & IRC
 
 Comments? Please feel free to email the notmuch mailing list:
@@ -140,9 +156,10 @@ channel.
 
 ## Feature ideas
 
 
 ## 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
 
 
 ## Website