X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=vim%2FREADME;h=53f1c4e12acb77ab8f9350a85ccc2cf6e0dc6275;hp=bd453a400ea5c1575025435d3f520ce33f2f4266;hb=41a29a84721235e33aff23bf6ef61b9ffdded2ef;hpb=df5137ff34d97b6dcdc90c8e07d9fb523b7bc2be

diff --git a/vim/README b/vim/README
index bd453a40..53f1c4e1 100644
--- a/vim/README
+++ b/vim/README
@@ -1,10 +1,86 @@
 This directory contains a vim script that allows reading notmuch mail
 through vim.
 
-To install:
+NOTE: this is a work in progress.  Patches welcome. <bart@jukie.net>
+
+Dependencies:
+    notmuch:
+        Naturally, it expects you have notmuch installed and configured.
+
+    sendmail:
+        To send mail, notmuch.vim uses sendmail as default.  Most modern MTAs
+        provide a compatibility binary, and so should work well.
 
+
+To install:
         make install
 
-To run:
 
+To run:
         vim -c ':NotMuch'
+
+    from vim:
+        :NotMuch
+        :NotMuch new to:bart@jukie.net 'subject:this is a test'
+
+
+Buffer types:
+    [notmuch-folders]
+        Folder list, or technically a list of saved searches.
+
+        Keybindings:
+            <Enter> - show the selected search
+            m       - compose a new message
+            s       - enter search criteria
+            =       - refresh display
+
+    [notmuch-search]
+        You are presented with the search results when you run :NotMuch.
+
+        Keybindings:
+            <Space> - show the selected thread collapsing unmatched items
+            <Enter> - show the entire selected thread
+            a       - archive message (remove inbox tag)
+            f       - filter the current search terms
+            o       - toggle search screen order
+            m       - compose a new message
+            r       - reply to thread
+            s       - enter search criteria
+            ,s      - alter search criteria
+            t       - filter the current search terms with tags
+            q       - return to folder display, or undo filter
+            +       - add tag(s) to selected message
+            -       - remove tag(s) from selected message
+            =       - refresh display
+            ?       - reveal the thread ID of what's under cursor
+            ^]      - search using word under cursor
+
+    [notmuch-show]
+        This is the display of the message.
+
+        Keybindings:
+            <Space> - mark read, archive, go to next matching message
+            ^n      - next message
+            ^p      - previous message
+            b       - toggle folding of message bodies
+            c       - toggle folding of citations
+            h       - toggle folding of extra header lines
+            i       - toggle folding of signatures
+            m       - compose a new message
+            r       - reply to the message
+            s       - enter search criteria
+            q       - return to search display
+            ?       - reveal the message and thread IDs of what's under cursor
+            ^]      - search using word under cursor
+
+    [notmuch-compose]
+        When you're writing an email, you're in this mode.
+
+        Insert-mode keybindings:
+            <Tab>   - go to the next header line
+
+        Normal-mode keybindings:
+            <Tab>   - go to the next header line
+            ,s      - send this message
+            ,q      - abort this message
+