diff --git a/README.md b/README.md index 9dbd744..86b252c 100644 --- a/README.md +++ b/README.md @@ -8,60 +8,60 @@ 1. Setup [Vundle]: - ``` - $ git clone http://github.com/gmarik/vundle.git ~/.vim/bundle/vundle - ``` + ``` + $ git clone http://github.com/gmarik/vundle.git ~/.vim/bundle/vundle + ``` 2. Configure bundles: - Sample `.vimrc`: - - ```vim - 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/'} - " vim-scripts repos - Bundle 'L9' - Bundle 'FuzzyFinder' - Bundle 'rails.vim' - " 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.. - - ``` + Sample `.vimrc`: + + ```vim + 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/'} + " vim-scripts repos + Bundle 'L9' + Bundle 'FuzzyFinder' + Bundle 'rails.vim' + " 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`. + Launch `vim`, run `:BundleInstall`. *Windows users* see [Vundle for Windows](https://github.com/gmarik/vundle/wiki/Vundle-for-Windows) Installing requires [Git] and triggers [Git clone](http://gitref.org/creating/#clone) for each configured repo to `~/.vim/bundle/`. - + 4. Consider donating [![](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=T44EJZX8RBUWY) @@ -74,7 +74,7 @@ [Vundle] allows to: - keep track and configure your scripts right in `.vimrc` -- [install] configured scripts (aka bundle) +- [install] configured scripts (aka bundle) - [update] configured scripts - [search] by name [all available vim scripts] - [clean] unused scripts up diff --git a/doc/vundle.txt b/doc/vundle.txt index 3b347ce..8c10e8f 100644 --- a/doc/vundle.txt +++ b/doc/vundle.txt @@ -28,7 +28,7 @@ Vundle is a short cut for Vim bundle and is the Vim plug-in manager. Vundle allows to: - keep track and configure your scripts right in `.vimrc` -- install configured scripts (aka bundle) +- install configured scripts (aka bundle) - update configured scripts - search [all available vim scripts] by name - clean up from unused scripts @@ -38,7 +38,7 @@ Also *Vundle* : - manages runtime path of your installed scripts - regenerates helptags automatically -Vundle takes advantage of [vim-scripts.org](http://vim-scripts.org) +Vundle takes advantage of [vim-scripts.org](http://vim-scripts.org) in order to install/search [all available vim scripts] 3. QUICK START ~ @@ -51,32 +51,32 @@ in order to install/search [all available vim scripts] Sample `.vimrc`: > - set nocompatible " be iMproved - filetype off " required! - - set rtp+=~/.vim/vundle.git/ - call vundle#rc() - - " let Vundle manage Vundle - Bundle 'gmarik/vundle' - - " My Bundles here: - " - " original repos on github - Bundle 'tpope/vim-fugitive' - Bundle 'Lokaltog/vim-easymotion' - Bundle 'rstacruz/sparkup', {'rtp': 'vim/'} - " vim-scripts repos - Bundle 'L9' - Bundle 'FuzzyFinder' - Bundle 'rails.vim' - " non github repos - Bundle 'git://git.wincent.com/command-t.git' - " ... - - filetype plugin indent on " required! - " or - " filetype plugin on " to not use the indentation settings set by plugins + set nocompatible " be iMproved + filetype off " required! + + set rtp+=~/.vim/vundle.git/ + call vundle#rc() + + " let Vundle manage Vundle + Bundle 'gmarik/vundle' + + " My Bundles here: + " + " original repos on github + Bundle 'tpope/vim-fugitive' + Bundle 'Lokaltog/vim-easymotion' + Bundle 'rstacruz/sparkup', {'rtp': 'vim/'} + " vim-scripts repos + Bundle 'L9' + Bundle 'FuzzyFinder' + Bundle 'rails.vim' + " non github repos + Bundle 'git://git.wincent.com/command-t.git' + " ... + + filetype plugin indent on " required! + " or + " filetype plugin on " to not use the indentation settings set by plugins 3) Install configured bundles: @@ -84,7 +84,7 @@ in order to install/search [all available vim scripts] :BundleInstall -Installing requires [Git] and triggers [Git clone](http://gitref.org/creating/#clone) for +Installing requires [Git] and triggers [Git clone](http://gitref.org/creating/#clone) for each configured repo to `~/.vim/bundle/`. 4. SCRIPTS ~ @@ -94,7 +94,7 @@ each configured repo to `~/.vim/bundle/`. Before installing scripts they need to be configured. It's done using `Bundle` command in `.vimrc`: > - Bundle 'git_repo_uri' " 'git_repo_uri' should be a valid uri to git repository + Bundle 'git_repo_uri' " 'git_repo_uri' should be a valid uri to git repository or > Bundle 'script_name' " 'script-name' should be an official script name (see |vundle-scripts-search| ) @@ -122,7 +122,7 @@ BundleInstall allows to install scripts by name:> :BundleInstall unite.vim installs and activates unite.vim. You can use Tab to auto-complete known script names. -NOTE: installation, as just described, doesn't automatically configure scripts; +NOTE: installation, as just described, doesn't automatically configure scripts; you have to configure them manually. 4.3 UPDATE SCRIPTS ~ @@ -170,11 +170,11 @@ run > :BundleClean -requires confirmation before removal of unused script-dirs from your `.vim/bundle`. +requires confirmation before removal of unused script-dirs from your `.vim/bundle`. *BundleClean!* > - :BundleClean! + :BundleClean! removes unused scripts with no questions. @@ -201,8 +201,8 @@ content: > Bundle 'unite-colorscheme' As the first line(starting with `"Keymap:`) shows, certain actions may be applied -to selected bundles . Move cursor over line `Bundle 'unite.vim'` and press i -key(install, see |vundle-keymappings| for more details). +to selected bundles . Move cursor over line `Bundle 'unite.vim'` and press i +key(install, see |vundle-keymappings| for more details). After unite.vim is installed - `:Unite file` command should be available to prove 'unite.vim' availability.