diff --git a/README.md b/README.md index 44d7b60..b98f79b 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,24 @@ Neosnippet ========== -# Description +The Neosnippet plugin 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 +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 +name. -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 +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 +Configuration +------------- Here is an example `~/.vimrc` configuration for Neosnippet. It is assumed you already have Neocomplecache configured. diff --git a/doc/neosnippet.txt b/doc/neosnippet.txt index c44dff8..7d66f7e 100644 --- a/doc/neosnippet.txt +++ b/doc/neosnippet.txt @@ -1,5 +1,5 @@ *neosnippet.txt* - neo-snippet plugin contains neocomplcache snippets source + The neo-snippet plugin contains the neocomplcache snippet source Version: 3.0 Author: Shougo @@ -41,9 +41,9 @@ Changelog |neosnippet-changelog| INTRODUCTION *neosnippet-introduction* This plugin analyzes snippet files which you can use for completion. It offers -functionality similar to snipMate.vim or snippetsEmu.vim. Since you can choose -snippets with the neocomplcache interface, you might have less trouble learning -it because you do not have to remember each snippet name. +functionality similar to |snipMate.vim| or |snippetsEmu.vim|. Since you can +choose snippets with the neocomplcache interface, you might have less trouble +using them, because you do not have to remember each snippet name. ============================================================================== INSTALL *neosnippet-install* @@ -73,7 +73,7 @@ COMMANDS *neosnippet-commands* :NeoSnippetEdit [{options}] [filetype] *:NeoSnippetEdit* Opens the [filetype] snippets to edit. It automatically selects - the current buffer's filetype unless you specify another by [filetype]. + the current buffer's filetype unless you specify another one by [filetype]. If the path to [filetype] snippets is a directory, it automatically selects the "[filetype].snip" in the [filetype] subdirectory. @@ -83,9 +83,8 @@ COMMANDS *neosnippet-commands* when you save the file after edit. *:NeoComplCacheEditSnippets* - {options} are options for the command. You may give the - following parameters as an option. Note: You must escape spaces with a - backslash "\". + The following parameters can be used as {options} to modify the behavior of + the command. Note: You must escape spaces with a backslash "\". *neosnippet-edit-options-vertical* -vertical @@ -114,7 +113,7 @@ COMMANDS *neosnippet-commands* :NeoComplCacheEdit -runtime [filetype] - Opens the [filetype] runtime snippets to edit. It automatically + Opens the [filetype] standard snippets to edit. It automatically selects the current buffer's file type snippets unless you specify a file type by [filetype]. The snippets are re-cached automatically when you save the file after edit.