|
| 1 | +## [Help Maintain Vundle](https://github.com/gmarik/Vundle.vim/issues/383) |
| 2 | + |
| 3 | +## About |
| 4 | + |
| 5 | +[Vundle] is short for _Vim bundle_ and is a [Vim] plugin manager. |
| 6 | + |
| 7 | +[Vundle] allows you to... |
| 8 | + |
| 9 | +* keep track of and [configure] your plugins right in the `.vimrc` |
| 10 | +* [install] configured plugins (a.k.a. scripts/bundle) |
| 11 | +* [update] configured plugins |
| 12 | +* [search] by name all available [Vim scripts] |
| 13 | +* [clean] unused plugins up |
| 14 | +* run the above actions in a *single keypress* with [interactive mode] |
| 15 | + |
| 16 | +[Vundle] automatically... |
| 17 | + |
| 18 | +* manages the [runtime path] of your installed scripts |
| 19 | +* regenerates [help tags] after installing and updating |
| 20 | + |
| 21 | +[Vundle] is undergoing an [interface change], please stay up to date to get latest changes. |
| 22 | + |
| 23 | +[](https://gitter.im/gmarik/Vundle.vim) for discussion and support. |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | +## Quick Start |
| 28 | + |
| 29 | +1. Introduction: |
| 30 | + |
| 31 | + Installation requires [Git] and triggers [`git clone`] for each configured repository to `~/.vim/bundle/` by default. |
| 32 | + Curl is required for search. |
| 33 | + |
| 34 | + If you are using Windows, go directly to [Windows setup]. If you run into any issues, please consult the [FAQ]. |
| 35 | + See [Tips] for some advanced configurations. |
| 36 | + |
| 37 | + Using non-POSIX shells, such as the popular Fish shell, requires additional setup. Please check the [FAQ]. |
| 38 | + |
| 39 | +2. Set up [Vundle]: |
| 40 | + |
| 41 | + `$ git clone https://github.com/gmarik/Vundle.vim.git ~/.vim/bundle/Vundle.vim` |
| 42 | + |
| 43 | +3. Configure Plugins: |
| 44 | + |
| 45 | + Put this at the top of your `.vimrc` to use Vundle. Remove plugins you don't need, they are for illustration purposes. |
| 46 | + |
| 47 | + ```vim |
| 48 | + set nocompatible " be iMproved, required |
| 49 | + filetype off " required |
| 50 | +
|
| 51 | + " set the runtime path to include Vundle and initialize |
| 52 | + set rtp+=~/.vim/bundle/Vundle.vim |
| 53 | + call vundle#begin() |
| 54 | + " alternatively, pass a path where Vundle should install plugins |
| 55 | + "call vundle#begin('~/some/path/here') |
| 56 | +
|
| 57 | + " let Vundle manage Vundle, required |
| 58 | + Plugin 'gmarik/Vundle.vim' |
| 59 | +
|
| 60 | + " The following are examples of different formats supported. |
| 61 | + " Keep Plugin commands between vundle#begin/end. |
| 62 | + " plugin on GitHub repo |
| 63 | + Plugin 'tpope/vim-fugitive' |
| 64 | + " plugin from http://vim-scripts.org/vim/scripts.html |
| 65 | + Plugin 'L9' |
| 66 | + " Git plugin not hosted on GitHub |
| 67 | + Plugin 'git://git.wincent.com/command-t.git' |
| 68 | + " git repos on your local machine (i.e. when working on your own plugin) |
| 69 | + Plugin 'file:///home/gmarik/path/to/plugin' |
| 70 | + " The sparkup vim script is in a subdirectory of this repo called vim. |
| 71 | + " Pass the path to set the runtimepath properly. |
| 72 | + Plugin 'rstacruz/sparkup', {'rtp': 'vim/'} |
| 73 | + " Avoid a name conflict with L9 |
| 74 | + Plugin 'user/L9', {'name': 'newL9'} |
| 75 | +
|
| 76 | + " All of your Plugins must be added before the following line |
| 77 | + call vundle#end() " required |
| 78 | + filetype plugin indent on " required |
| 79 | + " To ignore plugin indent changes, instead use: |
| 80 | + "filetype plugin on |
| 81 | + " |
| 82 | + " Brief help |
| 83 | + " :PluginList - lists configured plugins |
| 84 | + " :PluginInstall - installs plugins; append `!` to update or just :PluginUpdate |
| 85 | + " :PluginSearch foo - searches for foo; append `!` to refresh local cache |
| 86 | + " :PluginClean - confirms removal of unused plugins; append `!` to auto-approve removal |
| 87 | + " |
| 88 | + " see :h vundle for more details or wiki for FAQ |
| 89 | + " Put your non-Plugin stuff after this line |
| 90 | + ``` |
| 91 | + |
| 92 | +4. Install Plugins: |
| 93 | + |
| 94 | + Launch `vim` and run `:PluginInstall` |
| 95 | + |
| 96 | + To install from command line: `vim +PluginInstall +qall` |
| 97 | + |
| 98 | +## Docs |
| 99 | + |
| 100 | +See the [`:h vundle`](https://github.com/gmarik/Vundle.vim/blob/master/doc/vundle.txt) Vimdoc for more details. |
| 101 | + |
| 102 | +## Changelog |
| 103 | + |
| 104 | +See the [changelog](https://github.com/gmarik/Vundle.vim/blob/master/changelog.md). |
| 105 | + |
| 106 | +## People Using Vundle |
| 107 | + |
| 108 | +see [Examples](https://github.com/gmarik/Vundle.vim/wiki/Examples) |
| 109 | + |
| 110 | +## Contributors |
| 111 | + |
| 112 | +see [Vundle contributors](https://github.com/gmarik/Vundle.vim/graphs/contributors) |
| 113 | + |
| 114 | +*Thank you!* |
| 115 | + |
| 116 | +## Inspiration & Ideas |
| 117 | + |
| 118 | +* [pathogen.vim](http://github.com/tpope/vim-pathogen/) |
| 119 | +* [Bundler](https://github.com/bundler/bundler) |
| 120 | +* [Scott Bronson](http://github.com/bronson) |
| 121 | + |
| 122 | +## Also |
| 123 | + |
| 124 | +* Vundle was developed and tested with [Vim] 7.3 on OS X, Linux and Windows |
| 125 | +* Vundle tries to be as [KISS](http://en.wikipedia.org/wiki/KISS_principle) as possible |
| 126 | + |
| 127 | +## TODO: |
| 128 | +[Vundle] is a work in progress, so any ideas and patches are appreciated. |
| 129 | + |
| 130 | +* ✓ activate newly added bundles on `.vimrc` reload or after `:PluginInstall` |
| 131 | +* ✓ use preview window for search results |
| 132 | +* ✓ Vim documentation |
| 133 | +* ✓ put Vundle in `bundles/` too (will fix Vundle help) |
| 134 | +* ✓ tests |
| 135 | +* ✓ improve error handling |
| 136 | +* allow specifying revision/version? |
| 137 | +* handle dependencies |
| 138 | +* show description in search results |
| 139 | +* search by description as well |
| 140 | +* make it rock! |
| 141 | + |
| 142 | +[Vundle]:http://github.com/gmarik/Vundle.vim |
| 143 | +[Windows setup]:https://github.com/gmarik/Vundle.vim/wiki/Vundle-for-Windows |
| 144 | +[FAQ]:https://github.com/gmarik/Vundle.vim/wiki |
| 145 | +[Tips]:https://github.com/gmarik/Vundle.vim/wiki/Tips-and-Tricks |
| 146 | +[Vim]:http://www.vim.org |
| 147 | +[Git]:http://git-scm.com |
| 148 | +[`git clone`]:http://gitref.org/creating/#clone |
| 149 | + |
| 150 | +[Vim scripts]:http://vim-scripts.org/vim/scripts.html |
| 151 | +[help tags]:http://vimdoc.sourceforge.net/htmldoc/helphelp.html#:helptags |
| 152 | +[runtime path]:http://vimdoc.sourceforge.net/htmldoc/options.html#%27runtimepath%27 |
| 153 | + |
| 154 | +[configure]:https://github.com/gmarik/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L126-L233 |
| 155 | +[install]:https://github.com/gmarik/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L234-L254 |
| 156 | +[update]:https://github.com/gmarik/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L255-L265 |
| 157 | +[search]:https://github.com/gmarik/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L266-L295 |
| 158 | +[clean]:https://github.com/gmarik/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L303-L318 |
| 159 | +[interactive mode]:https://github.com/gmarik/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L319-L360 |
| 160 | +[interface change]:https://github.com/gmarik/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L372-L396 |
0 commit comments