From 7916b461688f25b84c2e8e6185124200474f0a1b Mon Sep 17 00:00:00 2001 From: Peter Odding Date: Sat, 25 May 2013 20:43:32 +0200 Subject: Document vim-misc as external dependency (needs to be installed separately from now on) --- INSTALL.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) (limited to 'INSTALL.md') diff --git a/INSTALL.md b/INSTALL.md index 1d863ca..4ad3c6d 100644 --- a/INSTALL.md +++ b/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/easytags.zip) from [Vim Online](http://www.vim.org/scripts/script.php?script_id=3114), unzip that in `~/.vim/` (on UNIX) or `%USERPROFILE%\vimfiles` (on Windows) and you're good to go. +*Please note that the vim-easytags 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-easytags] [download-easytags] 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). To get started execute `:Note` or `:edit note:`, this will start a new note that contains instructions on how to continue from there (and how to use the plug-in in general). + +If you prefer you can also use [Pathogen] [pathogen], [Vundle] [vundle] or a similar tool to install & update the [vim-easytags] [github-easytags] and [vim-misc] [github-misc] plug-ins using a local clone of the git repository. + + +[download-easytags]: http://peterodding.com/code/vim/downloads/easytags.zip +[download-misc]: http://peterodding.com/code/vim/downloads/misc.zip +[github-easytags]: http://github.com/xolox/vim-easytags +[github-misc]: http://github.com/xolox/vim-misc +[pathogen]: http://www.vim.org/scripts/script.php?script_id=2332 +[vundle]: https://github.com/gmarik/vundle -- cgit v1.2.3