Skip to content

Latest commit

 

History

History
148 lines (109 loc) · 4.97 KB

README.md

File metadata and controls

148 lines (109 loc) · 4.97 KB
Raw

Help Maintain Vundle

About

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

Vundle allows you to...

  • keep track of and configure your scripts right in the .vimrc
  • install configured scripts (a.k.a. bundle)
  • update configured scripts
  • search by name all available Vim scripts
  • clean unused scripts up
  • run the above actions in a single keypress with interactive mode

Vundle automatically...

Vundle-installer

Quick Start

  1. Introduction:

    Installation requires Git and triggers git clone for each configured repository to ~/.vim/bundle/ by default. Curl is required for search.

    If you are using Windows, go directly to Windows setup. If you run into any issues, please consult the FAQ.

  2. Set up Vundle:

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

  3. Configure Bundles:

    Put this at the top of your .vimrc to use Vundle. Remove bundles you don't need, they are for illustration purposes.

    set nocompatible              " be iMproved, required
filetype off                  " required

" set the runtime path to include Vundle and initialize
set rtp+=~/.vim/bundle/vundle/
call vundle#rc()
" alternatively, pass a path where Vundle should install bundles
"let path = '~/some/path/here'
"call vundle#rc(path)

" let Vundle manage Vundle, required
Bundle 'gmarik/vundle'

" The following are examples of different formats supported.
" Keep bundle commands between here and filetype plugin indent on.
" scripts on GitHub repos
Bundle 'tpope/vim-fugitive'
Bundle 'Lokaltog/vim-easymotion'
Bundle 'tpope/vim-rails.git'
" The sparkup vim script is in a subdirectory of this repo called vim.
" Pass the path to set the runtimepath properly.
Bundle 'rstacruz/sparkup', {'rtp': 'vim/'}
" scripts from http://vim-scripts.org/vim/scripts.html
Bundle 'L9'
Bundle 'FuzzyFinder'
" scripts not on GitHub
Bundle 'git://git.wincent.com/command-t.git'
" git repos on your local machine (i.e. when working on your own plugin)
Bundle 'file:///home/gmarik/path/to/plugin'
" ...

filetype plugin indent on     " required
" To ignore plugin indent changes, instead use:
"filetype plugin on
"
" 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 commands are not allowed.
" Put your stuff after this line

  4. Install Bundles:

    Launch vim and run :BundleInstall

    To install from command line: vim +BundleInstall +qall

Docs

See the :h vundle Vimdoc for more details.

People Using Vundle

see Examples

Contributors

see Vundle contributors

Thank you!

Inspiration & Ideas

Also

  • Vundle was developed and tested with Vim 7.3 on OS X, Linux and Windows
  • Vundle tries to be as KISS as possible

TODO:

Vundle is a work in progress, so any ideas and patches are appreciated.

  • ✓ activate newly added bundles on .vimrc reload or after :BundleInstall
  • ✓ use preview window for search results
  • ✓ Vim documentation
  • ✓ put Vundle in bundles/ too (will fix Vundle help)
  • ✓ tests
  • ✓ improve error handling
  • allow specifying revision/version?
  • handle dependencies
  • show description in search results
  • search by description as well
  • make it rock!