Skip to content
Browse files

Add instructions for making a vimball.

  • Loading branch information...
1 parent 68f242e commit f6f7cc649ad51c7adfa680cfc15bea35419f65e6 @nelstrom committed Mar 6, 2011
Showing with 13 additions and 0 deletions.
  1. +13 −0 README.md
View
13 README.md
@@ -73,6 +73,18 @@ The table of contents (TOC) generated by this method is rough and ready. It's ju
Ideally, I would prefer if the all figures were collected in a separate list. Also, I would like it if the TOC showed the heirarchy of a chapter by indenting `<title>`s from `<sect2>` and `<sect3>`. These optimisations would be nice, but even without them, this is a very useful feature.
+Generating a vimball
+--------------------
+
+To distribute the script on [vim.org][s] wrap it up as a vimball by following these steps:
+
+* open the file `vimballer` in Vim
+* set the variable `g:vimball_home` to the development directory of this plugin (e.g. run: `:let g:vimball_home='~/dotfiles/vim/bundle/pml'`)
+* visually select all lines in `vimballer` file
+* run `'<,'>MkVimball! pml.vba`
+
+That should create a file called `pml.vba` which you can upload to [vim.org][].
+
Credits
-------
@@ -95,3 +107,4 @@ Written and maintained by Drew Neil, with contributions from:
[snips]: https://github.com/nelstrom/vim-pml/blob/master/snippets/pml.snippets
[ctagrules]: https://github.com/nelstrom/vim-pml/blob/master/ctags
[wiki]: http://www.pragprog.com/wikis/authors/VimTools
+[vim.org]: http://www.vim.org/scripts/index.php

0 comments on commit f6f7cc6

Please sign in to comment.
Something went wrong with that request. Please try again.