vundle/README.md

153 lines
5.2 KiB
Markdown
Raw Normal View History

2014-02-16 23:11:35 -05:00
## [Help Maintain Vundle](https://github.com/gmarik/Vundle.vim/issues/241)
2014-02-05 19:19:57 -05:00
2010-10-17 19:18:08 -04:00
## About
[Vundle] is short for _Vim bundle_ and is a [Vim] plugin manager.
2010-10-17 20:00:48 -04:00
2014-02-16 23:11:35 -05:00
[Vundle] allows you to...
* keep track of and [configure] your plugins right in the `.vimrc`
* [install] configured plugins (a.k.a. scripts/bundle)
* [update] configured plugins
2014-02-16 23:11:35 -05:00
* [search] by name all available [Vim scripts]
* [clean] unused plugins up
2014-02-16 23:11:35 -05:00
* run the above actions in a *single keypress* with [interactive mode]
[Vundle] automatically...
* manages the [runtime path] of your installed scripts
* regenerates [help tags] after installing and updating
[Vundle] is undergoing an [interface change], please stay up to date to get latest changes.
2012-08-11 20:31:38 -04:00
![Vundle-installer](http://25.media.tumblr.com/tumblr_m8m96w06G81r39828o1_1280.png)
2011-08-28 14:57:35 -04:00
2014-02-16 23:11:35 -05:00
## Quick Start
2010-10-17 19:18:08 -04:00
2014-02-16 23:11:35 -05:00
1. Introduction:
2010-10-17 19:18:08 -04:00
2014-02-16 23:11:35 -05:00
Installation requires [Git] and triggers [`git clone`] for each configured repository to `~/.vim/bundle/` by default.
Curl is required for search.
2010-10-17 20:46:30 -04:00
2014-02-16 23:11:35 -05:00
If you are using Windows, go directly to [Windows setup]. If you run into any issues, please consult the [FAQ].
2010-10-19 00:15:44 -04:00
2014-02-16 23:11:35 -05:00
2. Set up [Vundle]:
`$ git clone https://github.com/gmarik/vundle.git ~/.vim/bundle/vundle`
3. Configure Plugins:
2014-02-16 23:11:35 -05:00
Put this at the top of your `.vimrc` to use Vundle. Remove plugins you don't need, they are for illustration purposes.
```vim
2014-02-16 23:11:35 -05:00
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 plugins
2014-02-16 23:11:35 -05:00
"let path = '~/some/path/here'
"call vundle#rc(path)
" let Vundle manage Vundle, required
Plugin 'gmarik/vundle'
2014-02-16 23:11:35 -05:00
" The following are examples of different formats supported.
" Keep Plugin commands between here and filetype plugin indent on.
2014-02-16 23:11:35 -05:00
" scripts on GitHub repos
Plugin 'tpope/vim-fugitive'
Plugin 'Lokaltog/vim-easymotion'
Plugin 'tpope/vim-rails.git'
2014-02-16 23:11:35 -05:00
" The sparkup vim script is in a subdirectory of this repo called vim.
" Pass the path to set the runtimepath properly.
Plugin 'rstacruz/sparkup', {'rtp': 'vim/'}
2014-02-16 23:11:35 -05:00
" scripts from http://vim-scripts.org/vim/scripts.html
Plugin 'L9'
Plugin 'FuzzyFinder'
2014-02-16 23:11:35 -05:00
" scripts not on GitHub
Plugin 'git://git.wincent.com/command-t.git'
2014-02-16 23:11:35 -05:00
" git repos on your local machine (i.e. when working on your own plugin)
Plugin 'file:///home/gmarik/path/to/plugin'
" ...
2014-02-16 23:11:35 -05:00
filetype plugin indent on " required
" To ignore plugin indent changes, instead use:
"filetype plugin on
"
" Brief help
" :PluginList - list configured plugins
" :PluginInstall(!) - install (update) plugins
" :PluginSearch(!) foo - search (or refresh cache first) for foo
" :PluginClean(!) - confirm (or auto-approve) removal of unused plugins
"
" see :h vundle for more details or wiki for FAQ
" NOTE: comments after Plugin commands are not allowed.
" Put your stuff after this line
```
2011-03-11 10:50:50 -05:00
4. Install Plugins:
2010-11-02 23:11:20 -04:00
Launch `vim` and run `:PluginInstall`
2010-12-09 00:12:58 -05:00
To install from command line: `vim +PluginInstall +qall`
2010-11-23 17:31:59 -05:00
2011-02-18 22:35:58 -05:00
## Docs
See the [`:h vundle`](https://github.com/gmarik/vundle/blob/master/doc/vundle.txt) Vimdoc for more details.
2014-02-16 23:11:35 -05:00
## People Using Vundle
2010-11-23 17:31:59 -05:00
see [Examples](https://github.com/gmarik/vundle/wiki/Examples)
2011-05-23 16:24:13 -04:00
## Contributors
2011-04-15 19:41:18 -04:00
see [Vundle contributors](https://github.com/gmarik/vundle/graphs/contributors)
2011-04-15 19:41:18 -04:00
*Thank you!*
2014-02-16 23:11:35 -05:00
## Inspiration & Ideas
2010-10-17 20:00:48 -04:00
2014-02-16 23:11:35 -05:00
* [pathogen.vim](http://github.com/tpope/vim-pathogen/)
* [Bundler](https://github.com/bundler/bundler)
* [Scott Bronson](http://github.com/bronson)
2010-10-17 19:18:08 -04:00
2011-02-10 22:49:50 -05:00
## Also
* Vundle was developed and tested with [Vim] 7.3 on OS X, Linux and Windows
2011-02-10 22:49:50 -05:00
* Vundle tries to be as [KISS](http://en.wikipedia.org/wiki/KISS_principle) as possible
2010-10-17 19:18:08 -04:00
## TODO:
[Vundle] is a work in progress, so any ideas and patches are appreciated.
* ✓ activate newly added bundles on `.vimrc` reload or after `:PluginInstall`
* ✓ 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?
2011-08-26 03:12:35 -04:00
* handle dependencies
2011-05-24 20:17:28 -04:00
* show description in search results
2011-08-26 03:12:35 -04:00
* search by description as well
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
2014-02-16 23:11:35 -05:00
[Windows setup]:https://github.com/gmarik/vundle/wiki/Vundle-for-Windows
[FAQ]:https://github.com/gmarik/vundle/wiki
[Vim]:http://www.vim.org
2010-10-17 20:18:58 -04:00
[Git]:http://git-scm.com
2014-02-16 23:11:35 -05:00
[`git clone`]:http://gitref.org/creating/#clone
[Vim scripts]:http://vim-scripts.org/vim/scripts.html
[help tags]:http://vimdoc.sourceforge.net/htmldoc/helphelp.html#:helptags
[runtime path]:http://vimdoc.sourceforge.net/htmldoc/options.html#%27runtimepath%27
[configure]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L122-L205
[install]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L207-L226
[update]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L228-L237
[search]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L239-L267
[clean]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L276-L289
[interactive mode]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L292-L331
[interface change]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L345-L369