vundle/README.md
2010-11-26 15:05:58 -06:00

90 lines
2.4 KiB
Markdown

## About
[Vundle] is a short cut for **V**imb**undle** and is a small plugin for managing [Vim] plugins.
## Why
[Vundle] allows to:
- keep track and configure your scripts right in <code>.vimrc</code>
- 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]
## How
1. Setup [Vundle]:
git clone http://github.com/gmarik/vundle.git ~/.vim/vundle.git
2. Configure bundles:
Append to your <code>~/.vimrc</code>:
set rtp+=~/.vim/vundle.git/
call vundle#rc()
" My bundles
Bundle "L9"
Bundle "FuzzyFinder"
Bundle "rails.vim"
Bundle "ack.vim"
Bundle "git://git.wincent.com/command-t.git"
3. Install configured bundles:
Launch <code>vim</code>, run <code>:BundleInstall</code> and **restart Vim**.
Installing requires [Git] and triggers [Git clone](http://gitref.org/creating/#clone) for each configured repo to <code>~/.vim/bundle/</code>.
## Searching
:BundleSearch foo
will split new window with results:
Bundle "VimFootnotes"
Bundle "foo.vim"
so you can just copy ones you need to <code>.vimrc</code>.
:BundleSearch! foo
will refresh scripts list before doing search.
Searching requires [<code>curl</code>](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
* [pathogen]
* [bundler]
* [Scott Bronson](http://github.com/bronson)
## TODO:
[Vundle] is a work in progress so any ideas/patches appreciated
* activate newly added bundles on .vimrc reload or after :BundleInstall
* improve error handling
* allow specify revision/version?
* 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
[Pathogen]:http://github.com/tpope/vim-pathogen/
[Bundler]:http://github.com/wycats/bundler/
[Vim]:http://vim.org
[Git]:http://git-scm.com
[all available vim scripts]:http://vim-scripts.org/scripts.html