From 0cb87c2c5763c8f2f450b82bf47b1122a041361c Mon Sep 17 00:00:00 2001 From: gmarik Date: Tue, 23 Nov 2010 16:31:59 -0600 Subject: [PATCH] Docs --- README.md | 34 ++++++++++++++++------------------ 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 64c1eaa..2eec0f2 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,11 @@ ## Why [Vundle] can: -- automatically install vim scripts (aka bundle) +- keep track and configure your scripts right in .vimrc +- install configured scripts (aka bundle) - manage runtime path of your installed scripts so you don't have to +- search [all available vim scripts] by name - disable/enable bundles by commenting/uncommenting configured Bundle(requires reload) -- NEW: search [all available vim scripts] by name [Vundle] takes advantage of [vim-scripts.org](http://vim-scripts.org) in order to install/search [all available vim scripts] @@ -21,7 +22,7 @@ in order to install/search [all available vim scripts] 2. Configure bundles: - Add to your ~/.vimrc: + Append to your ~/.vimrc: set rtp+=~/.vim/vundle.git/ call vundle#rc() @@ -32,22 +33,13 @@ in order to install/search [all available vim scripts] Bundle "rails.vim" Bundle "ack.vim" Bundle "git://git.wincent.com/command-t.git" - " check http://vim-scripts.org for more 3. Install configured bundles: - Launch vim, run :BundleInstall and restart Vim. + Launch vim, run :BundleInstall and **restart Vim**. - Or from command line: + BundleInstall requires [Git] and triggers [Git clone](http://gitref.org/creating/#clone) for each configured repo to ~/.vim/bundle/. - $ vim -e -c 'BundleInstall' -c 'q' - - - triggers [Git clone](http://gitref.org/creating/#clone) for each configured repo to ~/.vim/bundle/. - - **Make sure to restart Vim after installing new scripts**. - - See [gmarik's vimrc](https://github.com/gmarik/vimfiles/blob/1f4f26d42f54443f1158e0009746a56b9a28b053/vimrc#L136) for working example. ## Searching @@ -58,9 +50,14 @@ Will split new window with results: Bundle "VimFootnotes" Bundle "foo.vim" -So you can just copy one you need to you .vimrc. +So you can just copy ones you need to .vimrc. -Searching requires [curl](http://curl.haxx.se/) +BundleSearch requires [curl](http://curl.haxx.se/) + + +## Examples + + See [gmarik's vimrc](https://github.com/gmarik/vimfiles/blob/1f4f26d42f54443f1158e0009746a56b9a28b053/vimrc#L136) for working example. ## Inspiration and ideas from @@ -71,12 +68,13 @@ Searching requires [curl](http://curl.haxx.se/) ## TODO: [Vundle] is a work in progress so any ideas/patches appreciated -* tests +* activate newly added bundles on .vimrc reload or after :BundleInstall * allow specify revision/version? -* activate newly added bundles on .vimrc reload * search by description aswell * show descrption in search results * use location list/quick fix list for search results +* documentation +* tests * make it rock! [Vundle]:http://github.com/gmarik/vundle