mirror of
https://github.com/joaotavora/yasnippet.git
synced 2025-10-14 05:23:04 +00:00
imported README from googlecode's homepage
This commit is contained in:
parent
c213401bba
commit
a7996623f5
47
README
47
README
@ -1,8 +1,45 @@
|
|||||||
YASnippet re-design and re-writing of my original extension
|
*YASnippet* is a template system for Emacs. It allows you to type an
|
||||||
smart-snippet. The goal is ease of use and full features.
|
abbreviation and automatically expand it into function
|
||||||
|
templates. Bundled language templates includes: C, C++, C#, Perl, Python, Ruby,
|
||||||
|
SQL, LaTeX, HTML, CSS and more. The snippet syntax is inspired from [http://manual.macromates.com/en/snippets TextMate's] syntax, you can even
|
||||||
|
[http://yasnippet.googlecode.com/svn/trunk/doc/snippet-development.html#importing-textmate-snippets import] most !TextMate templates to YASnippet. Watch [http://www.youtube.com/watch?v=76Ygeg9miao a demo at YouTube] or download a higher resolution version ([http://yasnippet.googlecode.com/files/yas_demo.avi yas_demo.avi])
|
||||||
|
|
||||||
For detailed document, you can either download the document
|
====Install with yasnippet-bundle.el====
|
||||||
release of YASnippet or view it directly online:
|
|
||||||
|
|
||||||
http://pluskid.lifegoo.com/upload/project/yasnippet/doc/index.html
|
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 on the right sidebar and unpack it.
|
||||||
|
# You'll get a file named `yasnippet-bundle.el`, put it in `~/.emacs.d/plugins/` (create that directory if not exists).
|
||||||
|
# Open the file in Emacs, and type `Alt+x eval-buffer`.
|
||||||
|
|
||||||
|
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)
|
||||||
|
}}}
|
||||||
|
|
||||||
|
==== Normal install ====
|
||||||
|
|
||||||
|
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 your ~/.emacs.d/plugins and add the following in
|
||||||
|
your .emacs file:
|
||||||
|
{{{
|
||||||
|
(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")
|
||||||
|
}}}
|
||||||
|
|
||||||
|
====How-tos, Bugs, Contributions...====
|
||||||
|
|
||||||
|
Please refer to the comprehensive
|
||||||
|
[http://yasnippet.googlecode.com/svn/trunk/doc/index.html documentation] for full customization and support. If you find a bug, please report it at [http://code.google.com/p/yasnippet/issues/list issues list]. If you run into problems using YASnippet, or have snippets to contribute, post to the [http://groups.google.com/group/smart-snippet yasnippet google group]. Thank you very much for using YASnippet!
|
Loading…
x
Reference in New Issue
Block a user