c4220abc8b
- move requirements down: quick start must be quick ) - add contributors section |
||
---|---|---|
autoload | ||
doc | ||
ftplugin | ||
README.md | ||
test |
About
Vundle is a short cut for Vimbundle and is a Vim plugin manager.
Quick start
-
Setup Vundle:
git clone http://github.com/gmarik/vundle.git ~/.vim/vundle.git
-
Configure bundles:
Put into your
~/.vimrc
:set rtp+=~/.vim/vundle.git/ call vundle#rc() " Bundles: Bundle "L9" Bundle "FuzzyFinder" Bundle "rails.vim" Bundle "ack.vim" Bundle "git://git.wincent.com/command-t.git" " ... " NOTE: if some plugins fail to work, put the config *between* lines: " filetype off " "Bundles here " filetype plugin indent on
-
Install configured bundles:
Launch
vim
, run:BundleInstall
. Windows users see Requrements / Windows sectionInstalling requires Git and triggers Git clone for each configured repo to
~/.vim/bundle/
.
Why Vundle
Vundle allows to:
- keep track and configure your scripts right in
.vimrc
- install configured scripts (aka bundle)
- update configured scripts
- search all available vim scripts by name
- clean unused scripts up
- run above actions in a single keypress with interactive mode
Also Vundle:
- manages runtime path of your installed scripts
- regenerates helptag atomatically
Docs
see :h vundle
vimdoc for more details.
Examples
See gmarik's vimrc for working example.
Requirements:
Vundle requires the git
and curl
commandline tools. These can be
installed through the regular means for your operating system.
Windows support
On Windows you can install git
using
msysgit.
The curl
Windows binary can be found on the
curl website. Copy the files to where you'd like
to store them (%PROGRAMFILES%\curl
is a pretty good choice).
Both git
and curl
must be added to the PATH environment variable for
Vundle to work. The msysgit installer provides an option to add git to the
path automatically.
You can edit your Windows PATH environment variable by right-clicking
on My Computer and selecting selecting Properties (Windows Vista/7 users
must also click Advanced System Settings
). Go to the Advanced tab and
click Environment Variables...
. Append the path where you installed
curl
to the Path
system variable.
Contributors
- Brad Anderson (windows support)
- Ryan W
- gmarik
Inspiration and ideas from
Also
- Vundle was developed and tested with Vim 7.3 on
OSX
andLinux
- Vundle tries to be as KISS as possible
TODO:
Vundle is a work in progress so any ideas/patches appreciated
- √ activate newly added bundles on .vimrc reload or after :BundleInstall
- √ use preview window for search results
- √ vim documentation
- tests
- improve error handling
- :VundleUpdate - self.update
- handle dependencies
- allow specify revision/version?
- search by description aswell
- show descrption in search results
- instead sourcing .vimrc before installation come up with another solution
- make it rock!