vundle/README.md

90 lines
2.4 KiB
Markdown
Raw Normal View History

2010-10-17 19:18:08 -04:00
## About
2010-11-02 23:20:01 -04:00
[Vundle] is a short cut for **V**imb**undle** and is a small plugin for managing [Vim] plugins.
2010-10-17 20:00:48 -04:00
2010-11-02 23:11:20 -04:00
## Why
2010-11-26 13:37:16 -05:00
[Vundle] allows to:
2010-11-02 23:20:01 -04:00
2010-11-23 17:31:59 -05:00
- keep track and configure your scripts right in <code>.vimrc</code>
- install configured scripts (aka bundle)
2010-11-02 23:11:20 -04:00
- manage runtime path of your installed scripts so you don't have to
2010-11-23 17:31:59 -05:00
- search [all available vim scripts] by name
2010-11-02 23:11:20 -04:00
- disable/enable bundles by commenting/uncommenting configured Bundle(requires reload)
2010-10-17 19:18:08 -04:00
2010-11-02 23:11:20 -04:00
[Vundle] takes advantage of [vim-scripts.org](http://vim-scripts.org)
in order to install/search [all available vim scripts]
2010-10-17 19:18:08 -04:00
2010-11-02 23:11:20 -04:00
## How
2010-10-17 19:18:08 -04:00
2010-11-02 23:11:20 -04:00
1. Setup [Vundle]:
2010-10-17 19:18:08 -04:00
2010-11-02 23:55:47 -04:00
git clone http://github.com/gmarik/vundle.git ~/.vim/vundle.git
2010-10-17 20:46:30 -04:00
2010-11-02 23:11:20 -04:00
2. Configure bundles:
2010-10-19 00:15:44 -04:00
2010-11-23 17:31:59 -05:00
Append to your <code>~/.vimrc</code>:
2010-10-19 00:26:53 -04:00
2010-11-02 23:11:20 -04:00
set rtp+=~/.vim/vundle.git/
call vundle#rc()
2010-10-19 00:15:44 -04:00
2010-11-02 23:11:20 -04:00
" My bundles
Bundle "L9"
Bundle "FuzzyFinder"
Bundle "rails.vim"
Bundle "ack.vim"
Bundle "git://git.wincent.com/command-t.git"
2010-10-17 19:18:08 -04:00
2010-11-02 23:11:20 -04:00
3. Install configured bundles:
2010-10-17 19:18:08 -04:00
2010-11-23 17:31:59 -05:00
Launch <code>vim</code>, run <code>:BundleInstall</code> and **restart Vim**.
2010-10-17 20:00:48 -04:00
2010-11-26 13:37:16 -05:00
Installing requires [Git] and triggers [Git clone](http://gitref.org/creating/#clone) for each configured repo to <code>~/.vim/bundle/</code>.
2010-11-02 23:11:20 -04:00
## Searching
2010-11-02 23:24:55 -04:00
:BundleSearch foo
2010-11-02 23:11:20 -04:00
2010-11-26 16:05:58 -05:00
will split new window with results:
2010-11-02 23:11:20 -04:00
2010-11-02 23:24:55 -04:00
Bundle "VimFootnotes"
Bundle "foo.vim"
2010-11-02 23:11:20 -04:00
2010-11-26 16:05:58 -05:00
so you can just copy ones you need to <code>.vimrc</code>.
2010-11-23 17:31:59 -05:00
2010-11-26 13:37:16 -05:00
:BundleSearch! foo
2010-11-03 00:51:55 -04:00
2010-11-26 16:05:58 -05:00
will refresh scripts list before doing search.
2010-11-26 13:37:16 -05:00
Searching requires [<code>curl</code>](http://curl.haxx.se/)
2010-11-23 17:31:59 -05:00
## Examples
See [gmarik's vimrc](https://github.com/gmarik/vimfiles/blob/1f4f26d42f54443f1158e0009746a56b9a28b053/vimrc#L136) for working example.
2010-10-17 20:00:48 -04:00
## Inspiration and ideas from
2010-10-17 20:00:48 -04:00
* [pathogen]
* [bundler]
* [Scott Bronson](http://github.com/bronson)
2010-10-17 19:18:08 -04:00
## TODO:
2010-11-02 23:11:20 -04:00
[Vundle] is a work in progress so any ideas/patches appreciated
2010-10-17 19:18:08 -04:00
2010-11-23 17:31:59 -05:00
* activate newly added bundles on .vimrc reload or after :BundleInstall
2010-11-26 13:37:16 -05:00
* improve error handling
2010-11-02 23:11:20 -04:00
* allow specify revision/version?
* search by description aswell
* show descrption in search results
2010-11-29 17:43:49 -05:00
* √ use preview window for search results
2010-11-23 17:31:59 -05:00
* documentation
* tests
2010-11-02 23:11:20 -04:00
* make it rock!
2010-10-17 20:18:58 -04:00
[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
2010-11-27 17:03:37 -05:00
[all available vim scripts]:http://vim-scripts.org/vim/scripts.html