Browse files

Add more meaningful documentation.

  • Loading branch information...
1 parent 993af61 commit 646d79ca609aabdefab11cc18fadf6eade8aae8e @shlomif committed Feb 28, 2012
Showing with 46 additions and 5 deletions.
  1. +46 −5 doc/add-to-word-search.txt
View
51 doc/add-to-word-search.txt
@@ -1,15 +1,56 @@
-*range-search.txt* Plugin for searching inside ranges
+*add-to-word-search.txt* Plugin to append more words to searches.
==============================================================================
Author: Shlomi Fish < http://www.shlomifish.org/ >
License: MIT/X11 ( http://www.opensource.org/licenses/mit-license.php )
==============================================================================
-:[range]Rs {pattern} *:Rs*
+Motivation for this plugin:
+---------------------------
- Searches the range for the pattern.
+When searching through code one often needs to add more related
+terms to the search. For example, if I found a call to a function inside
+a different one, or when a type is typedef'ed to something else (in C).
+This module aims to allow you to convenietly add search terms to the search
+so you can find all the occurences of all of them.
+To use: put this in ~/.vim/plugin/ , which can be typed by installing the
+Ruby rake package and typing "rake install".
-:[range]RS {pattern} *:RS*
+Then you can type <Leader>** to add a search term to the search (mnemonic -
+* is the namespace and '*' searches forward for a keyword) and <Leader>## to
+add a search term to the search and search backwards (mnemonic -
+## like the vim # command).
- Same as :Rs.
+<Leader>**
+
+ Add the pattern matched by "*" to the search and searches forward in the
+ current search pattern.
+
+<Leader>##
+
+ Add the pattern matched by "#" to the search and searches backward in
+ the current search pattern.
+
+=================================================
+
+The code for this plugin can be found on GitHub:
+
+https://github.com/shlomif/add-to-word-search.vim
+
+Forks, issue reports, and pull requests would be welcome.
+
+Some of the stuff I'd like to add to this plugin:
+
+1. Add commands corresponding to other * and #-like commands:
+
+g*
+g#
+
+2. Add some colon commands to add more keywords to the search.
+
+Enjoy!
+
+Regards,
+
+-- Shlomi Fish

0 comments on commit 646d79c

Please sign in to comment.