]> git.cworth.org Git - notmuch-wiki/blobdiff - index.mdwn
index: merge bug reporting and feature requests
[notmuch-wiki] / index.mdwn
index 46e9e3930af1c3ff148783f4977b908b9845b87f..73f8552c968f7abd9c467566febef53b34f74981 100644 (file)
@@ -16,6 +16,8 @@ email, but don't want to give a 3rd-party access to your email...
 
 Then notmuch may be exactly what you've been looking for.
 
+[[!toc levels=2]]
+
 ## Why is it named Notmuch?
 
 * "Not much mail" is what Notmuch thinks about your email
@@ -51,12 +53,26 @@ Then notmuch may be exactly what you've been looking for.
 
 [[The latest news from notmuch|news]]
 
-## Documentation
+## Getting Started
 
-To get started with notmuch, just run "notmuch" at the command line.
+To get started with Notmuch, just run "notmuch" at the command line.
 This command will walk you through initial setup, including specifying
 the location of your mail store and how to start the initial indexing.
-After that, come back and checkout our documentation:
+
+For a little more detailed guide, see [[Getting Started with
+Notmuch|getting-started]].
+
+## Email Clients and Front Ends
+
+Notmuch ships with a powerful set of [[command-line tools|manpages]], an
+[[email client for Emacs|notmuch-emacs]], 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.
+
+## Documentation
 
   * [[Notmuch manual pages|manpages]]
   * [[General how-tos|howto]]
@@ -64,24 +80,15 @@ After that, come back and checkout our documentation:
   * [[Searching]]
   * [[Excluding and deleting messages|excluding]]
   * [[Initial tagging|Initial_Tagging]]
-  * [[Tips for using notmuch within Emacs|emacstips]]
-  * [[Remote usage|remoteusage]]
+  * Tips for using Notmuch with [[Emacs|emacstips]], [[Vim|vimtips]], and [[Mutt|mutttips]]
+  * [[Emacs remote usage|remoteusage]]
   * [[Performance|performance]]
   * [[References|references]]
+  * [[Notmuch Library Language Bindings|bindings]]
 
 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|notmuch-emacs]], 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]]
@@ -114,12 +121,13 @@ versions can be checked out via git with this command:
 
         git clone git://notmuchmail.org/git/notmuch
 
-You can browse the
-[Notmuch code history online](http://git.notmuchmail.org/git/notmuch). 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.
+You can browse the [Notmuch code history
+online](http://git.notmuchmail.org/git/notmuch). A notification is sent to the
+[notmuch-commits mailing
+list](http://notmuchmail.org/mailman/listinfo/notmuch-commits) for every commit
+made to Notmuch and the notmuchmail.org web site. [The Notmuch OpenHub project
+page](https://www.openhub.net/p/notmuch) has a nice summary of the codebase and
+activity.
 
 We have a [buildbot](http://buildbot.notmuchmail.org/grid) (here's
 its
@@ -128,16 +136,10 @@ its
 Contributions, such as patches, to Notmuch are most welcome. Please refer to the
 [[guide to contributing|contributing]].
 
-## Troubleshooting and reporting bugs
-
-For hints about troubleshooting and bug reporting see [[bugs]].
-
-For a list of known bugs see the [[nmbug status page|http://nmbug.notmuchmail.org/status/#Bugs]]
-
 ## Contact: Email & IRC
 
 Comments? Please feel free to email the notmuch mailing list:
-notmuch@notmuchmail.org (subscription is not required, but you can
+<mailto:notmuch@notmuchmail.org> (subscription is not required, but you can
 also subscribe to the
 [notmuch mailing list](http://notmuchmail.org/mailman/listinfo/notmuch)). You
 can also browse the
@@ -152,15 +154,21 @@ 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.
+[#notmuch](irc://chat.freenode.net/#notmuch)@irc.freenode.net IRC channel. Don't
+ask if you can ask a question, just ask, and please wait for an answer, we might
+not be in your timezone.
 
-## Feature ideas
+## Troubleshooting, Reporting Bugs and Feature Requests
+
+Please send bug reports and feature requests to the [Notmuch mailing
+list](http://notmuchmail.org/mailman/listinfo/notmuch)
+<mailto:notmuch@notmuchmail.org>.
+
+For hints about troubleshooting and bug reporting see [[bugs]].
 
-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.
+Please see the [nmbug status page](http://nmbug.notmuchmail.org/status/) for
+lists of [known bugs](http://nmbug.notmuchmail.org/status/#Bugs) and [feature
+requests](http://nmbug.notmuchmail.org/status/#Wish-list).
 
 ## Website