improves the readme example section

This commit is contained in:
cpfaff 2012-10-31 09:17:27 +01:00
parent ab79760f3f
commit 7d90008c75

View File

@ -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'
```