From b65efa5aa7556d9b687e4dc67a8a7deab7668a33 Mon Sep 17 00:00:00 2001 From: Holger Rapp Date: Tue, 4 Mar 2014 17:56:48 +0100 Subject: [PATCH] Added quickstart to readme. And reworded a bit. --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ README.rst | 22 ---------------------- 2 files changed, 45 insertions(+), 22 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..213bbff --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +UltiSnips +========= + +The official home of UltiSnips is at . +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 if you use https://github.com/Valloric/YouCompleteMe. + let g:UltiSnipsExpandTrigger="" + let g:UltiSnipsJumpForwardTrigger="" + let g:UltiSnipsJumpBackwardTrigger="" + + " 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/) + diff --git a/README.rst b/README.rst deleted file mode 100644 index a5c261f..0000000 --- a/README.rst +++ /dev/null @@ -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/