From ab79760f3f419dec5bf6b71e385f02d12da0f19a Mon Sep 17 00:00:00 2001 From: cpfaff Date: Wed, 31 Oct 2012 09:11:33 +0100 Subject: [PATCH 1/2] improves readme installation section --- README.md | 36 +++++++++++++++++++++++++++++++++--- 1 file changed, 33 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b98f79b..0590403 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ Neosnippet ========== -The Neosnippet plugin adds snippet support to vim. Snippets are +The Neosnippet plug-In adds snippet support to Vim. Snippets are small templates for commonly used code that you can fill in on the -fly. To use snippets can increase your productivity in vim a lot. -The functionality of this plugin is quite similar to plugins like +fly. To use snippets can increase your productivity in Vim a lot. +The functionality of this plug-in is quite similar to plug-ins like snipMate.vim or snippetsEmu.vim. But since you can choose snippets with the [Neocomplecache](https://github.com/Shougo/neocomplcache) interface, you might have less trouble using them, because you do not have to remember each snippet @@ -13,10 +13,40 @@ name. Installation ------------ +To install this Vim plug-in it is recommended to use one of the popular package +managers for Vim, rather than installing by drag and drop all required files +into your `.vim` folder. + +### Manual (not recommended) + 1. Install [Neocomplecache](https://github.com/Shougo/neocomplcache) first. 2. Put files in your Vim directory (usually `~/.vim/` or `%PROGRAMFILES%/Vim/vimfiles` on Windows). +### Vundle + +1. Setup the [vundle](https://github.com/gmarik/vundle) package manager +2. Set the bundles for [Neocomplecache](https://github.com/Shougo/neocomplcache) and [Neobundle](https://github.com/Shougo/neosnippet) + +``` +Bundle 'Shougo/neocomplcache.git' +Bundle 'Shougo/neosnippet.git' +``` + +3. Open up Vim and start installation with `:BundleInstall` + +### Neobundle + +1. Setup the [neobundle](https://github.com/Shougo/neobundle.vim) package manager +2. Set the bundles for [Neocomplecache](https://github.com/Shougo/neocomplcache) and [Neobundle](https://github.com/Shougo/neosnippet) + +``` +NeoBundle 'Shougo/neocomplcache.git' +NeoBundle 'Shougo/neosnippet.git' +``` + +3. Open up Vim and start installation with `:NeoBundleInstall` + Configuration ------------- From 7d90008c75d250303782e30a0459332fa1cefd43 Mon Sep 17 00:00:00 2001 From: cpfaff Date: Wed, 31 Oct 2012 09:17:27 +0100 Subject: [PATCH 2/2] improves the readme example section --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 0590403..2673dfe 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,13 @@ name. Installation ------------ -To install this Vim plug-in it is recommended to use one of the popular package -managers for Vim, rather than installing by drag and drop all required files -into your `.vim` folder. +To install neosnippet and other Vim plug-ins it is recommended to use one of the +popular package managers for Vim, rather than installing by drag and drop all +required files into your `.vim` folder. ### Manual (not recommended) -1. Install [Neocomplecache](https://github.com/Shougo/neocomplcache) first. +1. Install the [Neocomplecache](https://github.com/Shougo/neocomplcache) plugin first. 2. Put files in your Vim directory (usually `~/.vim/` or `%PROGRAMFILES%/Vim/vimfiles` on Windows). @@ -50,10 +50,9 @@ NeoBundle 'Shougo/neosnippet.git' Configuration ------------- -Here is an example `~/.vimrc` configuration for Neosnippet. It is assumed -you already have Neocomplecache configured. - -With these settings, you will use the following keys: +This is an example `~/.vimrc` configuration for Neosnippet. It is assumes you +already have Neocomplecache configured. With the settings of the example, you +can use the following keys: * `C-k` to select-and-expand a snippet from the Neocomplecache popup (Use `C-n` and `C-p` to select it). `C-k` can also be used to jump to the next field in @@ -76,12 +75,13 @@ endif ``` -If you want to use a different collection of snippets other than the built-in -ones, such as [Honza's Snippets](https://github.com/honza/snipmate-snippets), then you -can set the `g:neosnippet#snippets_directory` variable. +If you want to use a different collection of snippets than the +built-in ones, then you can set a path to the snippets with +the `g:neosnippet#snippets_directory` variable (e.g [Honza's +Snippets](https://github.com/honza/snipmate-snippets)) ```vim -" Tell Neosnippet about these snippets +" Tell Neosnippet about the other snippets let g:neosnippet#snippets_directory='~/.vim/bundle/snipmate-snippets/snippets' ```