From b5bb5a5d0260c0bc53d67b827df823ef158565dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20T=C3=A1vora?= Date: Thu, 15 Dec 2011 01:51:25 +0000 Subject: [PATCH 1/2] Added section on using imported textmate snippets --- README.mdown | 49 +++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 45 insertions(+), 4 deletions(-) diff --git a/README.mdown b/README.mdown index ba9585f..ef642cc 100755 --- a/README.mdown +++ b/README.mdown @@ -14,9 +14,11 @@ SQL, LaTeX, HTML, CSS and more. The snippet syntax is inspired from [textmate-snippets]: http://manual.macromates.com/en/snippets [import-docs]: http://yasnippet.googlecode.com/svn/trunk/doc/snippet-development.html#importing-textmate-snippets [youtube-demo]: http://www.youtube.com/watch?v=76Ygeg9miao -[high-res-demo]: http://yasnippet.googlecode.com/files/yas_demo.avi +[high-res-demo]: http://yasnippet.googlecode.com/files/yas_demo.avi -# Install the most recent version +# Installation + +## Install the most recent version Clone this repository somewhere @@ -32,13 +34,13 @@ Add the following in your `.emacs` file: Add your own snippets to `~/.emacs.d/snippets` by placing files there or invoking `yas/new-snippet`. -# Install yasnippet with el-get +## Install yasnippet with el-get El-get is a nice way to get the most recent version, too See https://github.com/dimitri/el-get for instructions -# How-tos, Bugs, Contributions... +# Writing snippets, How-tos, Bugs, Contributions... Please refer to the comprehensive [documentation] [docs] for full customization and support. If you find a bug, please report it on @@ -48,6 +50,45 @@ and support. If you find a bug, please report it on If you run into problems using YASnippet, or have snippets to contribute, post to the [yasnippet google group][forum]. Thank you very much for using YASnippet! +# Contributing snippets + +Please do not ask me to add snippets to the default collection under +`/snippets`. This is considered frozen and by customizing +`yas/snippet-dirs` you can point yasnippet to good snippet collections +out there. + +There is a tool `extras/textmate-import.rb` than can import many +actual Textmate snippets and there are +`extras/imported/*-mode/.yas-setup.el` files that can help it with the +more difficult importation. + +I'm focusing on developping `textmate-import.rb` tool and the +`yas-setup.el` files. In the future `/snippets` snippets will be +deprecated and replaced with `extras/imported`. + +Follow through the following example to start using these snippets for +rails development. It will convert `ruby`, `rails` and `html` bundles +from drnic's github repositories based on corresponding +`.yas-setup.el` files. + +After cloning this repository to `~/.emacs.d/plugins/yasnippet` + + cd ~/.emacs.d/plugins/yasnippet + git submodule init + git submodule update + gem install plist trollop + rake convert_bundles # will convert ruby, rails and html bundles from drnic + +Then, in your .emacs file + + (add-to-list 'load-path + "~/.emacs.d/plugins/yasnippet") + (require 'yasnippet) + (setq yas/snippet-dirs "~/.emacs.d/snippets" "~/.emacs.d/extras/imported") + (yas/global-mode 1) + +Open some rails file (model, app, etc) and start using the textmate snippets. + [docs]: http://capitaomorte.github.com/yasnippet/ [issues]: https://github.com/capitaomorte/yasnippet/issues [googlecode tracker]: http://code.google.com/p/yasnippet/issues/list From 0d3eedc0144890e5bb156edb3783c81f2189cf3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20T=C3=A1vora?= Date: Thu, 15 Dec 2011 01:56:15 +0000 Subject: [PATCH 2/2] Slightly reorganized new README.mdown --- README.mdown | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.mdown b/README.mdown index ef642cc..d0d7b69 100755 --- a/README.mdown +++ b/README.mdown @@ -40,16 +40,6 @@ El-get is a nice way to get the most recent version, too See https://github.com/dimitri/el-get for instructions -# Writing snippets, How-tos, Bugs, Contributions... - -Please refer to the comprehensive [documentation] [docs] for full customization -and support. If you find a bug, please report it on -[the GitHub issue tracker][issues]. (please **do not** submit new issues to the old -[googlecode tracker][googlecode tracker]) - -If you run into problems using YASnippet, or have snippets to contribute, post -to the [yasnippet google group][forum]. Thank you very much for using YASnippet! - # Contributing snippets Please do not ask me to add snippets to the default collection under @@ -71,6 +61,8 @@ rails development. It will convert `ruby`, `rails` and `html` bundles from drnic's github repositories based on corresponding `.yas-setup.el` files. +## Using imported textmate snippets (rails example) + After cloning this repository to `~/.emacs.d/plugins/yasnippet` cd ~/.emacs.d/plugins/yasnippet @@ -89,10 +81,19 @@ Then, in your .emacs file Open some rails file (model, app, etc) and start using the textmate snippets. +# Documentation, issues, etc + +Please refer to the comprehensive [documentation] [docs] for full customization +and support. If you find a bug, please report it on +[the GitHub issue tracker][issues]. (please **do not** submit new issues to the old +[googlecode tracker][googlecode tracker]) + +If you run into problems using YASnippet, or have snippets to contribute, post +to the [yasnippet google group][forum]. Thank you very much for using YASnippet! + [docs]: http://capitaomorte.github.com/yasnippet/ [issues]: https://github.com/capitaomorte/yasnippet/issues [googlecode tracker]: http://code.google.com/p/yasnippet/issues/list [forum]: http://groups.google.com/group/smart-snippet -