README

                      vim-update-bundles


Use Pathogen and Git to easily set up and manage your Vim plugins.


DESCRIPTION

This script reads BUNDLE: directives from your .vimrc, then updates the
.vim/bundle directory to match.  For example, to load NERDTree, add this
line to your .vimrc:

    " BUNDLE: git://github.com/scrooloose/nerdtree.git


INSTALL

NOTE: If you currently use vim, it's best to rename your ~/.vim directory
and ~/.vimrc file and start fresh.

  $ wget http://github.com/bronson/vim-update-bundles/raw/master/vim-update-bundles
  $ ruby vim-update-bundles

Now you have a working barebones environment.  Open ~/.vimrc, enable a few
plugins, then run vim-update-bundles again to apply your changes.

vim-update-bundles will install into a ~/.dotfiles directory if it exists.
It works seamlessly with http://github.com/ryanb/dotfiles and friends.


USAGE

From within Vim, run ':help bundles' to list all the bundles you have
installed, along with hotlinks to their help pages.

Run vim-update-bundles at any time to ensure your plugins, syntax files,
and color schemes are all up to date.  You can find more plugins to
install on http://github.com/vim-scripts


VIMRC

Any line of the format '" BUNDLE: URL [REV]' will be interpreted as a
bundle to download.  URL is a git repository url, and REV is an optional
git refspec (branch name, tag name, or sha1) that allows you to lock a
plugin to a particular revision:

    " BUNDLE: git://github.com/scrooloose/nerdtree.git 4.0.0

This ensures your NerdTree remains at version 4.0.0.  If NerdTree releases
a new version, just update the version number in your vimrc and re-run
vim-update-bundles.

You can put any number of BUNDLE-COMMAND: directives after BUNDLE.
This will execute the given shell commands from the bundle's directory.
For instance, to automatically build Command-T every time
git-update-bundles is run:

    " BUNDLE: git://github.com/bronson/Command-T.git
    " BUNDLE-COMMAND: rake make


BUNDLES.TXT

From within Vim, type ':help bundles' to show a list of the bundes you
have installed.  vim-update-bundles produces this file every time it runs.


Q&A

Q: How do I install a plugin?
A: Add a line like this to your ~/.vimrc
     " BUNDLE: git://github.com/bronson/vim-closebuffer.git
   (use your own url of course) then run git-update-bundles.

Q: How do I remove a plugin?
A: Delete the BUNDLE: line and run git-update-bundles.


ALTERNATIVES

vim-addon-manager: http://www.vim.org/scripts/script.php?script_id=2905
  http://github.com/MarcWeber/vim-addon-manager
  Written in vimscript, doesn't need pathogen(?)
Vimana: http://github.com/c9s/Vimana
  Written in Perl, dumps everything into .vimrc (no pathogen)


HISTORY

This script was inspired by Tammer Saleh's blog post in March 2010:
  http://tammersaleh.com/posts/the-modern-vim-config-with-pathogen