Source

vimpire / README

-*- markdown -*-

Alpha baby! It will drink your blood. In case it doesn't, you should drink your own blood!

This is a script that manages plugins hosted on git or hg and make them available
to pathogen, so it make your vim ever the more awesome!

First off, this script assumes you have a file called `vimrc` in your dotvim directory,
which might as well be linked to your `~/.vimrc` file. In that file, put lines like
the following, (one for each plugin you want):

	" Bundle: git://github.com/tpope/vim-pathogen.git

Note: You'll anyway need the above line at least, you of course need pathogen, silly.
Note: You can get github links from http://vim-scripts.org for plugins that don't offer
sane deployment options.

Add any number such bundle lines with various plugins. Vimpire will try to guess the
vcs from git or hg, and is correct most of the time, but if you want to specify it
yourself, do so as

	" Bundle: my-strange-url-from-which-no-one-can-tell-the-vcs with git

There, that `with git` in the end is what tells Vimpire what vcs to use. Neat eh?

You can also decide what folder the plugin will be cloned to, by using the `to` option
in a similar way to the `with` option as described above. For example,

    " Bundle: git://github.com/tpope/vim-pathogen.git to super-plugin

And this will cause the pathogen plugin to be cloned to `bundle/super-plugin` instead of
`bundle/vim-pathogen`.

And of course, you can have a line with both the `with` and the `to` options, along with
any other that might be added in the future ;).

Now, navigate to your vimfiles or dotvim directory and do

	$ wget http://bitbucket.org/sharat87/vimpire/raw/428f69cf2d16/vimpire.py
	$ python vimpire.py

You may also include a `Run` directive below the `Bundle` directive to run a command
after getting/updating the corresponding bundle. Note that this command will be run
with the plugin's directory as the pwd. For example

    " Bundle: git://github.com/tpope/vim-pathogen.git
    " Run: ls -lh

Deleting plugins is still experimental, but adding new ones and updating (pull) ing
them works just fine.

Report any issues whatsoever :)