[PATCH 13/13] vim: README: sync with upstream

Subject: [PATCH 13/13] vim: README: sync with upstream

Date: Sun, 18 Apr 2021 17:48:51 -0500

To: notmuch@notmuchmail.org

Cc: Felipe Contreras

From: Felipe Contreras


Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 vim/README | 27 +++++++++++++++++----------
 1 file changed, 17 insertions(+), 10 deletions(-)

diff --git a/vim/README b/vim/README
index c137bacd..d9a635a2 100644
--- a/vim/README
+++ b/vim/README
@@ -3,7 +3,7 @@
 This is a vim plug-in that provides a fully usable mail client interface,
 utilizing the notmuch framework, through it's ruby bindings.
 
-== install ==
+== Install ==
 
 Simply run 'make install'. However, check that you have the dependencies below.
 
@@ -12,6 +12,8 @@ Simply run 'make install'. However, check that you have the dependencies below.
 Make sure your vim version has ruby support: check for +ruby in 'vim --version'
 features.
 
+ % vim --version | grep +ruby
+
 === ruby bindings ===
 
 Check if you are able to run the following command cleanly:
@@ -28,16 +30,10 @@ directory in the notmuch source tree.
 
 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:
+'mail':
 
  % 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 ==
@@ -46,6 +42,15 @@ Simple:
 
  % gvim -c ':NotMuch'
 
+You might want to write a wrapper script (e.g. `vnm`)
+
+ #!/bin/sh
+ gvim -c ":NotMuch $*"
+
+So you can run:
+
+ vnm is:inbox date:yesterday..
+
 Enjoy ;)
 
 == More stuff ==
@@ -53,10 +58,12 @@ Enjoy ;)
 As an example to configure a key mapping to add the tag 'to-do' and archive,
 this is what I use:
 
-let g:notmuch_rb_custom_search_maps = {
+----
+let g:notmuch_custom_search_maps = {
 	\ 't':		'search_tag("+to-do -inbox")',
 	\ }
 
-let g:notmuch_rb_custom_show_maps = {
+let g:notmuch_custom_show_maps = {
 	\ 't':		'show_tag("+to-do -inbox")',
 	\ }
+----
-- 
2.31.0
_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: