From d10ee801d69b44ab80feb0c03e760c5cf47da0d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Ho=CC=88ltje?= Date: Mon, 29 Oct 2012 19:00:04 -0400 Subject: [PATCH] Added initial README This is a simple readme which should give people at least a starting point for installation and configuration. --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..44d7b60 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +Neosnippet +========== + +# Description + +Neosnippet add snippet support to vim, using the [Neocomplecache](https://github.com/Shougo/neocomplcache) framework. + +What is a snippet? It's a template for commonly used code that you can fill in on the fly. + +# Installation + +1. Install [Neocomplecache](https://github.com/Shougo/neocomplcache) first. +2. Put files in your Vim directory (usually `~/.vim/` or + `%PROGRAMFILES%/Vim/vimfiles` on Windows). + +# 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: + +* `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 + the snippet. +* `Tab` to select the next field to fill in the snippet. + +```vim +" Plugin key-mappings. +imap (neosnippet_expand_or_jump) +smap (neosnippet_expand_or_jump) + +" SuperTab like snippets behavior. +imap neosnippet#expandable() ? "\(neosnippet_expand_or_jump)" : pumvisible() ? "\" : "\" +smap neosnippet#expandable() ? "\(neosnippet_expand_or_jump)" : "\" + +" For snippet_complete marker. +if has('conceal') + set conceallevel=2 concealcursor=i +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. + +```vim +" Tell Neosnippet about these snippets +let g:neosnippet#snippets_directory='~/.vim/bundle/snipmate-snippets/snippets' +``` +