Permalink
Browse files

Document vim-misc as external dependency

  • Loading branch information...
1 parent cc0c218 commit 4cb3c4cc483ef2f89c65e8c8fe886ef8a9321c04 @xolox committed Aug 19, 2013
Showing with 9 additions and 3 deletions.
  1. +4 −2 INSTALL.md
  2. +5 −1 README.md
View
@@ -1,3 +1,5 @@
-If you're looking for the simplest way to get the plug-in up and running, download [the latest ZIP archive](http://peterodding.com/code/vim/downloads/publish.zip) from [Vim Online](http://www.vim.org/scripts/script.php?script_id=2252), unzip that in `~/.vim/` (on UNIX) or `%USERPROFILE%\vimfiles` (on Windows) and you're good to go.
+*Please note that the vim-publish plug-in requires my vim-misc plug-in which is separately distributed.*
-If you're using git and/or [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332), [Vundle](https://github.com/gmarik/vundle) or a similar plug-in manager and want to keep the plug-in up to date using git, you can use the GitHub repository directly, it should just work.
+Unzip the most recent ZIP archives of the [vim-publish](http://peterodding.com/code/vim/downloads/publish.zip) and [vim-misc](http://peterodding.com/code/vim/downloads/misc.zip) plug-ins inside your Vim profile directory (usually this is `~/.vim` on UNIX and `%USERPROFILE%\vimfiles` on Windows), restart Vim and execute the command `:helptags ~/.vim/doc` (use `:helptags ~\vimfiles\doc` instead on Windows).
+
+If you prefer you can also use [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332), [Vundle](https://github.com/gmarik/vundle) or a similar tool to install & update the [vim-publish](https://github.com/xolox/vim-publish) and [vim-misc](https://github.com/xolox/vim-misc) plug-ins using a local clone of the git repository.
View
@@ -6,7 +6,11 @@ After several attempts I managed a working prototype, but it was quite rough aro
## Installation & usage
-Unzip the most recent [ZIP archive](http://peterodding.com/code/vim/downloads/publish.zip) file inside your Vim profile directory (usually this is `~/.vim` on UNIX and `%USERPROFILE%\vimfiles` on Windows), restart Vim and execute the command `:helptags ~/.vim/doc` (use `:helptags ~\vimfiles\doc` instead on Windows). As an example we'll publish the plug-in using itself. First create a tags file that contains entries for the files you want to publish using a shell command such as:
+*Please note that the vim-publish plug-in requires my vim-misc plug-in which is separately distributed.*
+
+Unzip the most recent ZIP archives of the [vim-publish](http://peterodding.com/code/vim/downloads/publish.zip) and [vim-misc](http://peterodding.com/code/vim/downloads/misc.zip) plug-ins inside your Vim profile directory (usually this is `~/.vim` on UNIX and `%USERPROFILE%\vimfiles` on Windows), restart Vim and execute the command `:helptags ~/.vim/doc` (use `:helptags ~\vimfiles\doc` instead on Windows). If you prefer you can also use [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332), [Vundle](https://github.com/gmarik/vundle) or a similar tool to install & update the [vim-publish](https://github.com/xolox/vim-publish) and [vim-misc](https://github.com/xolox/vim-misc) plug-ins using a local clone of the git repository.
+
+As an example we'll publish the plug-in using itself. First create a tags file that contains entries for the files you want to publish using a shell command such as:
$ ctags -Rf ~/.publish_tags ~/.vim/

0 comments on commit 4cb3c4c

Please sign in to comment.