From 584edaee4b107c69a3ae1671d82c834eaaa3a57a Mon Sep 17 00:00:00 2001 From: Peter Odding Date: Thu, 2 Apr 2015 21:14:14 +0200 Subject: Update installation instructions --- INSTALL.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) (limited to 'INSTALL.md') diff --git a/INSTALL.md b/INSTALL.md index 4ad3c6d..944731b 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,13 +1,15 @@ +# Installation instructions + *Please note that the vim-easytags plug-in requires my vim-misc plug-in which is separately distributed.* -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). +There are two ways to install the vim-easytags plug-in and it's up to you which you prefer, both options are explained below. Please note that below are generic installation instructions while some Vim plug-ins may have external dependencies, please refer to the plug-in's [readme](README.md) for details. + +## Installation using ZIP archives + +Unzip the most recent ZIP archives of the [vim-easytags](http://peterodding.com/code/vim/downloads/easytags.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] [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. +If you get warnings about overwriting existing files while unpacking the ZIP archives you probably don't need to worry about this because it's most likely caused by files like `README.md`, `INSTALL.md` and `addon-info.json`. If these files bother you then you can remove them after unpacking the ZIP archives, they are not required to use the plug-in. +## Installation using a Vim plug-in manager -[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 +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 and update the [vim-easytags](https://github.com/xolox/vim-easytags) and [vim-misc](https://github.com/xolox/vim-misc) plug-ins using local clones of the git repositories. This takes a bit of work to set up the first time but it makes updating much easier, and it keeps each plug-in in its own directory which helps to keep your Vim profile uncluttered. -- cgit v1.2.3