From 4afef1116ce4a8ae62605d4817942bce7a7f99e0 Mon Sep 17 00:00:00 2001 From: Abel Martin Date: Mon, 26 Mar 2012 13:11:24 -0300 Subject: [PATCH] Completed the documentation style and content updates --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2887be7..db4353f 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,26 @@ # Installation -The NERD Commenter requires Vim 7 or higher. -Extract the plugin files in your ~/.vim (*nix) or ~/vimfiles (Windows). You -should have 2 files: +*\*For simplicity, let's use **[VIM_ROOT]** which will mean ~/.vim (\*nix) or ~/vimfiles (Windows)* +The NERD Commenter requires Vim 7 or higher is comprised of 2 files: plugin/NERD_commenter.vim doc/NERD_commenter.txt -Next, to finish installing the help file run: -* :helptags ~/.vim/doc +### Classic Install + +1. Extract the plugin files in your **[VIM_ROOT]**/pulgin and **[VIM_ROOT]**/doc folders respectively. +2. Finish the install by updating your help files. Run: + +
:helptags **[VIM_ROOT]**/doc
See **|add-local-help|** for more details. -Make sure that you have filetype plugins enabled, as the script makes use of +### Pathogen Install +1. Navigate to your **[VIM_ROOT]/bundle** directory in your local Vim setup +2. git clone https://github.com/scrooloose/nerdcommenter.git + +### Post Install +After the **'Classic'** or **'Pathogen'** install, make sure that you have filetype plugins enabled, as the script makes use of **|'commentstring'|** where possible (which is usually set in a filetype plugin). See **|filetype-plugin-on|** for details, but basically, stick this in your vimrc: