Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Document vim-misc as external dependency

  • Loading branch information...
commit d57636a33c08f4246b28f0c4eb707067a71a5b1a 1 parent 712b775
@xolox authored
Showing with 26 additions and 3 deletions.
  1. +12 −2 INSTALL.md
  2. +14 −1 README.md
View
14 INSTALL.md
@@ -1,3 +1,13 @@
-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/pyref.zip) from [Vim Online](http://www.vim.org/scripts/script.php?script_id=3104), unzip that in `~/.vim/` (on UNIX) or `%USERPROFILE%\vimfiles` (on Windows) and you're good to go.
+*Please note that the vim-pyref 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-pyref] [download-pyref] and [vim-misc] [download-misc] 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] [pathogen], [Vundle] [vundle] or a similar tool to install & update the [vim-pyref] [github-pyref] and [vim-misc] [github-misc] plug-ins using a local clone of the git repository.
+
+
+[download-misc]: http://peterodding.com/code/vim/downloads/misc.zip
+[download-pyref]: http://peterodding.com/code/vim/downloads/pyref.zip
+[github-misc]: http://github.com/xolox/vim-misc
+[github-pyref]: http://github.com/xolox/vim-pyref
+[pathogen]: http://www.vim.org/scripts/script.php?script_id=2332
+[vundle]: https://github.com/gmarik/vundle
View
15 README.md
@@ -10,7 +10,20 @@ The `:PyRef` command looks up the identifier given as an argument while the `<F1
## Install & usage
-Unzip the most recent [ZIP archive](http://peterodding.com/code/vim/downloads/pyref) 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). Now try it out: Open a Python script and press the `<F1>` key on something interesting. If it doesn't work or you want to change how it works, see the options documented below.
+*Please note that the vim-pyref plug-in requires my vim-misc plug-in which is separately distributed.*
+
+Unzip the most recent ZIP archives of the [vim-pyref] [download-pyref] and [vim-misc] [download-misc] 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] [pathogen], [Vundle] [vundle] or a similar tool to install & update the [vim-pyref] [github-pyref] and [vim-misc] [github-misc] plug-ins using a local clone of the git repository.
+
+Now try it out: Open a Python script and press the `<F1>` key on something interesting. If it doesn't work or you want to change how it works, see the options documented below.
+
+[download-misc]: http://peterodding.com/code/vim/downloads/misc.zip
+[download-pyref]: http://peterodding.com/code/vim/downloads/pyref.zip
+[github-misc]: http://github.com/xolox/vim-misc
+[github-pyref]: http://github.com/xolox/vim-pyref
+[pathogen]: http://www.vim.org/scripts/script.php?script_id=2332
+[vundle]: https://github.com/gmarik/vundle
### The `g:pyref_mapping` option
Please sign in to comment.
Something went wrong with that request. Please try again.