vundle/README.md

About

Vundle is short for Vim bundle and is a Vim plugin manager.

Quick start

1. Setup Vundle:

   $ git clone https://github.com/gmarik/vundle.git ~/.vim/bundle/vundle
   

2. Configure bundles:

   Sample .vimrc:

   set nocompatible               " be iMproved
   filetype off                   " required!
   
   set rtp+=~/.vim/bundle/vundle/
   call vundle#rc()
   
   " let Vundle manage Vundle
   " required! 
   Bundle 'gmarik/vundle'
   
   " My Bundles here:
   "
   " original repos on github
   Bundle 'tpope/vim-fugitive'
   Bundle 'Lokaltog/vim-easymotion'
   Bundle 'rstacruz/sparkup', {'rtp': 'vim/'}
   Bundle 'tpope/vim-rails.git'
   " vim-scripts repos
   Bundle 'L9'
   Bundle 'FuzzyFinder'
   " non github repos
   Bundle 'git://git.wincent.com/command-t.git'
   " ...
   
   filetype plugin indent on     " required!
   "
   " Brief help
   " :BundleList          - list configured bundles
   " :BundleInstall(!)    - install(update) bundles
   " :BundleSearch(!) foo - search(or refresh cache first) for foo
   " :BundleClean(!)      - confirm(or auto-approve) removal of unused bundles
   "
   " see :h vundle for more details or wiki for FAQ
   " NOTE: comments after Bundle command are not allowed..
   
   

3. Install configured bundles:

   Launch vim, run :BundleInstall (or vim +BundleInstall +qall for CLI lovers)

   Windows users see Vundle for Windows

   Installing requires Git and triggers Git clone for each configured repo to ~/.vim/bundle/.

4. Consider donating

Thank you for supporting this project! )

Why Vundle

Vundle allows to:

• keep track and configure your scripts right in .vimrc
• install configured scripts (aka bundle)
• update configured scripts
• search by name all available vim scripts
• 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 automatically

Docs

see :h vundle vimdoc for more details.

People Using Vundle

see Examples

FAQ

see wiki

Contributors

see vundle contributors

Thank you!

Inspiration and ideas from

• pathogen
• bundler
• Scott Bronson

Also

• Vundle was developed and tested with Vim 7.3 on OSX, Linux and Windows
• 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
• √ put vundle to bundles/ too(will fix vundle help)
• √ tests
• √ improve error handling
• allow specify revision/version?
• handle dependencies
• show description in search results
• search by description as well
• make it rock!