code.delx.au - gnu-emacs-elpa/blob - README.mdown

   1 # Intro
   2
   3 **YASnippet** is a template system for Emacs. It allows you to type an
   4 abbreviation and automatically expand it into function
   5 templates. Bundled language templates includes: C, C++, C#, Perl,
   6 Python, Ruby,
   7
   8 SQL, LaTeX, HTML, CSS and more. The snippet syntax is inspired from
   9 [TextMate's][textmate-snippets] syntax, you can even
  10 [import][import-docs] most TextMate templates to YASnippet. Watch
  11 [a demo on YouTube][youtube-demo] or download a
  12 [higher resolution version][high-res-demo]
  13
  14 [textmate-snippets]: http://manual.macromates.com/en/snippets
  15 [import-docs]: http://yasnippet.googlecode.com/svn/trunk/doc/snippet-development.html#importing-textmate-snippets
  16 [youtube-demo]: http://www.youtube.com/watch?v=76Ygeg9miao
  17 [high-res-demo]: http://yasnippet.googlecode.com/files/yas_demo.avi
  18
  19 # Install the most recent version
  20
  21 Clone this repository somewhere
  22
  23     $ cd ~/.emacs.d/plugins
  24     $ git clone https://github.com/capitaomorte/yasnippet
  25
  26 Add the following in your `.emacs` file:
  27
  28     (add-to-list 'load-path
  29                   "~/.emacs.d/plugins/yasnippet")
  30     (require 'yasnippet) ;; not yasnippet-bundle
  31     (yas/global-mode 1)
  32
  33 Add your own snippets to `~/.emacs.d/snippets` by placing files there or invoking `yas/new-snippet`.
  34
  35 # Install yasnippet with el-get
  36
  37 El-get is a nice way to get the most recent version, too
  38
  39 See https://github.com/dimitri/el-get for instructions
  40
  41 # How-tos, Bugs, Contributions...
  42
  43 Please refer to the comprehensive [documentation] [docs] for full customization
  44 and support.  If you find a bug, please report it on
  45 [the GitHub issue tracker][issues].  (please **do not** submit new issues to the old
  46 [googlecode tracker][googlecode tracker])
  47
  48 If you run into problems using YASnippet, or have snippets to contribute, post
  49 to the [yasnippet google group][forum]. Thank you very much for using YASnippet!
  50
  51 [docs]: http://capitaomorte.github.com/yasnippet/
  52 [issues]: https://github.com/capitaomorte/yasnippet/issues
  53 [googlecode tracker]: http://code.google.com/p/yasnippet/issues/list
  54 [forum]: http://groups.google.com/group/smart-snippet
  55
  56
  57