vimpire / README

-*- markdown -*-

Alpha software! Like, alpha alpha, you know ;)

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/tip/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, to compile Command-T plugin,

    " Bundle: git://github.com/tpope/vim-pathogen.git
    " Run: cd ruby/command-t
    " Run: ruby extconf.rb && make

Note: If a run directive points to a `cd` command, like the 2nd line above, it is not
sent to the shell. It is natively interpreted by vimpire, and does NOT have all the
advanced functionality of the `cd` command in a shell. So, things like `cd -` do not work.
This should not affect for most users, though.

If a bundle entry is deleted, or a directory exists in the bundle directory, without a
corresponding entry in the vimrc file, it will be deleted. Deleting plugins is still
experimental, but if it does not work, you may manually delete the plugin directory in the
bundle directory.

Report any issues whatsoever :)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.