From aeb18a98d1b026989c61e8232bd4e733d3e7461d Mon Sep 17 00:00:00 2001 From: gmarik Date: Wed, 8 Dec 2010 23:12:58 -0600 Subject: [PATCH] Docs --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e6aae41..0e67c5d 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,6 @@ - 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) [Vundle] takes advantage of [vim-scripts.org](http://vim-scripts.org) in order to install/search [all available vim scripts] @@ -27,19 +26,25 @@ in order to install/search [all available vim scripts] set rtp+=~/.vim/vundle.git/ call vundle#rc() - " My bundles + " Bundles: Bundle "L9" Bundle "FuzzyFinder" Bundle "rails.vim" Bundle "ack.vim" Bundle "git://git.wincent.com/command-t.git" + " ... 3. Install configured bundles: - Launch vim, run :BundleInstall and **restart Vim**. + Launch vim, run :BundleInstall (**no restart required** since v0.5) Installing requires [Git] and triggers [Git clone](http://gitref.org/creating/#clone) for each configured repo to ~/.vim/bundle/. +## Script installation + + `BundleInstall` installs script only if it hasn't been already installed installed. + `BundleInstall` is faster than `BundleInstall!` (note bang at the end) because latter fetches scripts without any checks. + Use `BundleInstall!` to update scripts. ## Searching @@ -71,12 +76,13 @@ Searching requires [curl](http://curl.haxx.se/) ## TODO: [Vundle] is a work in progress so any ideas/patches appreciated -* activate newly added bundles on .vimrc reload or after :BundleInstall +* √ activate newly added bundles on .vimrc reload or after :BundleInstall +* √ use preview window for search results * improve error handling * allow specify revision/version? * search by description aswell * show descrption in search results -* √ use preview window for search results +* instead sourcing .vimrc before installation come up with another solution * documentation * tests * make it rock!