[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 with yasnippet-bundle.el
+# Installation
-To quickly tryout YASnippet, download the simpler "bundle" version.
-If you plan to modify the bundled templates and/or build your own,
-download the "normal" package.
-
-* Download `yasnippet-bundle` from the downloads section.
+## Install the most recent version
-* You'll get a file named `yasnippet-bundle.el`, put it in
- `~/.emacs.d/plugins/` (create that directory if not exists).
+Clone this repository somewhere
-* Open the file in Emacs, and type `M-x eval-buffer RET`.
+ $ cd ~/.emacs.d/plugins
+ $ git clone https://github.com/capitaomorte/yasnippet
+
+Add the following in your `.emacs` file:
-That's it. Now open any file, you'll see a menu "YASnippet". You can
-pull down the menu to insert a template. Or, you can type a
-pre-defined abbrev and press TAB to expand it!
-
-To have Emacs load YASnippet automatically when it starts, put the
-following in your ~/.emacs file:
-
(add-to-list 'load-path
- "~/.emacs.d/plugins")
- (require 'yasnippet-bundle)
+ "~/.emacs.d/plugins/yasnippet")
+ (require 'yasnippet)
+ (yas/global-mode 1)
+Add your own snippets to `~/.emacs.d/snippets` by placing files there or invoking `yas/new-snippet`.
-# Install
+## Install yasnippet with el-get
-To install the normal archive, download and unpack the latest
-`yasnippet-x.y.z.tar.bz2`. You'll get a directory named
-`yasnippet-x.y.z`, put it in some `~/.emacs.d/plugins` dir and add the
-following in your `.emacs` file:
+El-get is a nice way to get the most recent version, too
- (add-to-list 'load-path
- "~/.emacs.d/plugins/yasnippet-x.y.z")
- (require 'yasnippet) ;; not yasnippet-bundle
- (yas/initialize)
- (yas/load-directory "~/.emacs.d/plugins/yasnippet-x.y.z/snippets")
+See https://github.com/dimitri/el-get for instructions
+
+# 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.
-# How-tos, Bugs, Contributions...
+## Using imported textmate snippets (rails example)
-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** the deprecated
+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.
+
+# 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!
+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://yasnippet.googlecode.com/svn/trunk/doc/index.html
+[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
-