emacs: Add new option notmuch-search-hide-excluded

[notmuch] / vim / README

diff --git a/vim/README b/vim/README
index dffc88a42f9241ca29f8e4242b504a35d99a0e65..777c20c0e6f0b8a695fe2d997ddb7284660e5de2 100644 (file)
--- a/vim/README
+++ b/vim/README
@@ -1,36 +1,62 @@
-This directory contains a vim script that allows reading notmuch mail
-through vim.
+== notmuch vim ruby ==
 
-NOTE: this is a work in progress.  Patches welcome. <bart@jukie.net>
+This is a vim plug-in that provides a fully usable mail client interface,
+utilizing the notmuch framework, through it's ruby bindings.
 
-To install:
-        make install
+== install ==
 
-To run:
-        vim -c ':NotMuch'
+Simply run 'make install'. However, check that you have the dependencies below.
 
-    from vim:
-        :NotMuch
+=== vim +ruby ===
 
-Buffer types:
-    [notmuch-search]
-        You are presented with the search results when you run :NotMuch.
+Make sure your vim version has ruby support: check for +ruby in 'vim --version'
+features.
 
-        Keybindings:
-            <Enter> - show the selected message
-            a       - archive message (remove inbox tag)
-            s       - enter search criteria
-            S       - alter search criteria
-            +       - add tag(s) to selected message
-            -       - remove tag(s) from selected message
-            =       - refresh display
+=== ruby bindings ===
 
-    [notmuch-show]
-        This is the display of the message.
+Check if you are able to run the following command cleanly:
 
-        Keybindings:
-            q       - return to search display
-            ^n      - next message
-            s       - toggle folding of signatures on and off
-            c       - toggle folding of citations on and off
+ % ruby -e "require 'notmuch'"
 
+If you don't see any errors, it means it's working and you can go to the next
+section.
+
+If it's not, you would need to compile them. Go to the 'bindings/ruby'
+directory in the notmuch source tree.
+
+=== mail gem ===
+
+Since libnotmuch library concentrates on things other than handling mail, we
+need a library to do that, and for Ruby the best library for that is called
+'mail'. The easiest way to install it is with ruby's gem. In most distro's the
+package is called 'rubygems'.
+
+Once you have gem, run:
+
+ % gem install mail
+
+In some systems gems are installed on a per-user basis by default, so make sure
+you are running as the same user as the one that installed them.
+
+This gem is not mandatory, but it's extremely recommended.
+
+== Running ==
+
+Simple:
+
+ % gvim -c ':NotMuch'
+
+Enjoy ;)
+
+== More stuff ==
+
+As an example to configure a key mapping to add the tag 'to-do' and archive,
+this is what I use:
+
+let g:notmuch_custom_search_maps = {
+       \ 't':          'search_tag("+to-do -inbox")',
+       \ }
+
+let g:notmuch_custom_show_maps = {
+       \ 't':          'show_tag("+to-do -inbox")',
+       \ }