Skip to content

Latest commit

 

History

History
15 lines (8 loc) · 1.75 KB

INSTALL.md

File metadata and controls

15 lines (8 loc) · 1.75 KB

Installation instructions

Please note that the vim-notes plug-in requires my vim-misc plug-in which is separately distributed.

There are two ways to install the vim-notes 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 for details.

Installation using ZIP archives

Unzip the most recent ZIP archives of the vim-notes and vim-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 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

If you prefer you can also use Pathogen, Vundle or a similar tool to install and update the vim-notes and 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.