diff --git a/README.md b/README.md new file mode 100644 index 0000000..3b5b193 --- /dev/null +++ b/README.md @@ -0,0 +1,91 @@ +# Installation + +*\*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 + +### Classic Install + +1. Extract the plugin files into 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.
+
+### 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:
+
+ filetype plugin on
+
+# Usage
+
+The following key mappings are provided by default (there is also a menu
+provided that contains menu items corresponding to all the below mappings):
+
+Most of the following mappings are for normal/visual mode only. The |NERDComInsertComment| mapping is for insert mode only.
+
+**[count]\