From 0cbbcb56740fbba4c35b0c8f2ff32f0f32988c65 Mon Sep 17 00:00:00 2001 From: Zane Hitchcox Date: Tue, 24 May 2016 07:58:18 -0400 Subject: [PATCH 1/2] alternative pathogen download instructions --- README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 49 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ebaa927..718e124 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,73 @@ # 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 +## Via Plugin Manager (Recommended) -1. Extract the plugin files into your **[VIM_ROOT]**/plugin and **[VIM_ROOT]**/doc folders respectively. -2. Finish the install by updating your help files. Run: +#### Pathogen Install -
:helptags [VIM_ROOT]/doc
+###### Unix -See **|add-local-help|** for more details. +```sh +git clone https://github.com/scrooloose/nerdcommenter.git ~/.vim/bundle +``` -### Pathogen Install -1. Navigate to your **[VIM_ROOT]/bundle** directory in your local Vim setup -2. `git clone https://github.com/scrooloose/nerdcommenter.git` +###### Neovim -### Vundle Install +```sh +git clone https://github.com/scrooloose/nerdcommenter.git ~/.config/nvim/bundle +``` + +#### Vim-Plug Install +1. Add `Plug 'Plug scrooloose/nerdcommenter'` to your .vimrc file. +2. Reload .vimrc (`:so %` from vimrc, or just restart vim) +3. Run `:PlugInstall` + +#### Vundle Install 1. Add `Plugin 'scrooloose/nerdcommenter'` to your .vimrc file. 2. Run `:BundleInstall` -### Post Install +#### NeoBundle Install +1. Add `NeoBundle 'scrooloose/nerdcommenter'` to your .vimrc file. +2. Run `:NeoUpdate`` + +#### 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 +## Install Manually + +#### Vim + +###### Unix + +```sh +curl -fLo ~/.vim/plugin/NERD_commenter.vim --create-dirs \ + https://raw.githubusercontent.com/scrooloose/nerdcommenter/master/plugin/NERD_commenter.vim +``` + +###### Windows (PowerShell) + +```powershell +md ~\vimfiles\plugin +$uri = 'https://raw.githubusercontent.com/scrooloose/nerdcommenter/master/plugin/NERD_commenter.vim' +(New-Object Net.WebClient).DownloadFile($uri, $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath("~\vimfiles\autoload\NERD_commenter.vim")) +``` + +#### Neovim + +```sh +curl -fLo ~/.config/nvim/plugin/NERD_commenter.vim --create-dirs \ + https://raw.githubusercontent.com/scrooloose/nerdcommenter/master/plugin/NERD_commenter.vim +``` + + # Usage The following key mappings are provided by default (there is also a menu From 115854609128291ad60d7b5ae19ab393b7e7f5a0 Mon Sep 17 00:00:00 2001 From: "zane.hitchcox@one.verizon.com" Date: Tue, 24 May 2016 11:09:20 -0500 Subject: [PATCH 2/2] include entire repository in manual install --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 718e124..b6a899c 100644 --- a/README.md +++ b/README.md @@ -48,8 +48,7 @@ See **|filetype-plugin-on|** for details, but basically, stick this in your vimr ###### Unix ```sh -curl -fLo ~/.vim/plugin/NERD_commenter.vim --create-dirs \ - https://raw.githubusercontent.com/scrooloose/nerdcommenter/master/plugin/NERD_commenter.vim +git clone https://github.com/scrooloose/nerdcommenter.git ~/.vim/plugin ``` ###### Windows (PowerShell) @@ -63,8 +62,7 @@ $uri = 'https://raw.githubusercontent.com/scrooloose/nerdcommenter/master/plugin #### Neovim ```sh -curl -fLo ~/.config/nvim/plugin/NERD_commenter.vim --create-dirs \ - https://raw.githubusercontent.com/scrooloose/nerdcommenter/master/plugin/NERD_commenter.vim +git clone https://github.com/scrooloose/nerdcommenter.git ~/.config/nvim/plugin ```