Added documentation section to index page

[notmuch-wiki] / index.mdwn

diff --git a/index.mdwn b/index.mdwn
index 48693464d76f52c23e8941894a28b19fed901bd1..466fb42da279e2797207c7b94a4274e5980e7c9b 100644 (file)
--- a/index.mdwn
+++ b/index.mdwn
@@ -1,3 +1,4 @@
+[[!img notmuch-logo.png alt="Notmuch logo" class="left"]]

 # Why Notmuch?
 
 * "Not much mail" is what Notmuch thinks about your email
 # Why Notmuch?
 
 * "Not much mail" is what Notmuch thinks about your email


@@ -41,25 +42,62 @@ 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.
 
 support for arbitrary tags, then Notmuch also may be exactly what
 you've been looking for.
 

+## Documentation
+
+So far, there is notmuch documentation.  Eventually, the wiki will
+contain a reference for users.  This is what we have so far:
+
+* [[initialtagging|Initial Tagging]]
+
+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
 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 GPL version 3. The latest versions
+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:
 
 can be checked out via git with this command:
 

-

        git clone git://notmuchmail.org/git/notmuch
 
        git clone git://notmuchmail.org/git/notmuch
 

-Or you can browse the <a href="http://git.notmuchmail.org/git/notmuch">
-Notmuch code history</a> online.
+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.
+
+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).
+
+## Contact: Email & IRC

 
 Comments? Please feel free to email the notmuch mailing list:
 notmuch&#64;notmuchmail.org (subscription is not required, but you can
 
 Comments? Please feel free to email the notmuch mailing list:
 notmuch&#64;notmuchmail.org (subscription is not required, but you can

-<a href="http://notmuchmail.org/mailman/listinfo/notmuch">subscribe to
-the notmuch list</a> if you would like to). You can also browse the
-<a href="http://notmuchmail.org/pipermail/notmuch/">online archives
-</a> or the mailing list or download an <a href=
-"http://notmuchmail.org/archives/notmuch.mbox>mbox file</a>
-of the entire mailing-list. The mb2md utility can then be used to
-convert the archives to maildir format which is convenient for
-reading the archives within notmuch itself.
+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.
+
+## Emacs Tips and Tricks
+
+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).
+### Website
+
+This wiki is maintained using [ikiwiki](http://ikiwiki.info). You can pull and
+push changes using the following URL (no authentication necessary):
+
+    git://notmuchmail.org/git/notmuch-wiki
+
+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