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 -------------