Added quickstart to readme.
And reworded a bit.
This commit is contained in:
parent
7b51ec6f6b
commit
b65efa5aa7
45
README.md
Normal file
45
README.md
Normal file
@ -0,0 +1,45 @@
|
||||
UltiSnips
|
||||
=========
|
||||
|
||||
The official home of UltiSnips is at <https://github.com/sirver/ultisnips>.
|
||||
Please add pull requests and issues there.
|
||||
|
||||
UltiSnips is the ultimate solution for snippets in Vim. It has tons of features
|
||||
and is very fast.
|
||||
|
||||
Quick Start
|
||||
-----------
|
||||
|
||||
This assumes you are using [Vundle](https://github.com/gmarik/Vundle.vim). Adapt
|
||||
for your plugin manager of choice. Put this into your `.vimrc`.
|
||||
|
||||
" Track the engine.
|
||||
Bundle 'SirVer/ultisnips'
|
||||
|
||||
" Snippets are separated from the engine. Add this if you want them:
|
||||
Bundle 'honza/vim-snippets'
|
||||
|
||||
" Trigger configuration. Do not use <tab> if you use https://github.com/Valloric/YouCompleteMe.
|
||||
let g:UltiSnipsExpandTrigger="<tab>"
|
||||
let g:UltiSnipsJumpForwardTrigger="<c-b>"
|
||||
let g:UltiSnipsJumpBackwardTrigger="<c-z>"
|
||||
|
||||
" If you want :UltiSnipsEdit to split your window.
|
||||
let g:UltiSnipsEditSplit="vertical"
|
||||
|
||||
UltiSnips comes with comprehensive
|
||||
[documentation](https://github.com/SirVer/ultisnips/blob/master/doc/UltiSnips.txt).
|
||||
As there are more options and tons of features I suggest you at least skim it.
|
||||
|
||||
Screencasts
|
||||
-----------
|
||||
|
||||
From a gentle introduction to really advanced in a few minutes. The blog posts
|
||||
of the screencasts contain more advanced examples of the things
|
||||
discussed in the videos.
|
||||
|
||||
- [Episode 1: What are snippets and do I need them?](http://www.sirver.net/blog/2011/12/30/first-episode-of-ultisnips-screencast/)
|
||||
- [Episode 2: Creating Basic Snippets](http://www.sirver.net/blog/2012/01/08/second-episode-of-ultisnips-screencast/)
|
||||
- [Episode 3: What's new in version 2.0](http://www.sirver.net/blog/2012/02/05/third-episode-of-ultisnips-screencast/)
|
||||
- [Episode 4: Python Interpolation](http://www.sirver.net/blog/2012/03/31/fourth-episode-of-ultisnips-screencast/)
|
||||
|
22
README.rst
22
README.rst
@ -1,22 +0,0 @@
|
||||
UltiSnips
|
||||
=========
|
||||
|
||||
This is the official repository for UltiSnips. Send Pull request to
|
||||
SirVer/ultisnips, not the automatic clone from vim-scripts or any
|
||||
other fork of this project.
|
||||
|
||||
Screencasts
|
||||
-----------
|
||||
|
||||
The blog posts of the screencasts contain more advanced examples of the things
|
||||
discussed in the videos.
|
||||
|
||||
* `Episode 1: What are snippets and do I need them?`__
|
||||
* `Episode 2: Creating Basic Snippets`__
|
||||
* `Episode 3: What's new in version 2.0`__
|
||||
* `Episode 4: Python Interpolation`__
|
||||
|
||||
__ http://www.sirver.net/blog/2011/12/30/first-episode-of-ultisnips-screencast/
|
||||
__ http://www.sirver.net/blog/2012/01/08/second-episode-of-ultisnips-screencast/
|
||||
__ http://www.sirver.net/blog/2012/02/05/third-episode-of-ultisnips-screencast/
|
||||
__ http://www.sirver.net/blog/2012/03/31/fourth-episode-of-ultisnips-screencast/
|
Loading…
x
Reference in New Issue
Block a user