]> code.delx.au - gnu-emacs-elpa/blobdiff - README.mdown
Remove yas--inhibit-overlay-hooks macro.
[gnu-emacs-elpa] / README.mdown
index 14e193f2cdcf729c0f0a056d280c793d0b5d7257..716b620a4b7af8e96d0d0666397c4e5a709632fc 100644 (file)
@@ -8,12 +8,10 @@ templates. Bundled language templates include: C, C++, C#, Perl,
 Python, Ruby, SQL, LaTeX, HTML, CSS and more. The snippet syntax
 is inspired from [TextMate's][textmate-snippets] syntax, you can
 even [import](#import) most TextMate templates to
-YASnippet. Watch [a demo on YouTube][youtube-demo] or download a
-[higher resolution version][high-res-demo].
+YASnippet. Watch [a demo on YouTube][youtube-demo].
 
 [textmate-snippets]: http://manual.macromates.com/en/snippets
 [youtube-demo]: http://www.youtube.com/watch?v=ZCGmZK4V7Sg
-[high-res-demo]: http://yasnippet.googlecode.com/files/yas_demo.avi
 
 # Installation
 
@@ -41,28 +39,17 @@ In a recent emacs `M-x list-packages` is the recommended way to list and install
 ## Install 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. Be sure to install the
-"master" branch since the 3.x series still use the old googlecode code, base.
-Consider using this "local" recipe.
-
-    (push '(:name yasnippet
-                  :website "https://github.com/capitaomorte/yasnippet.git"
-                  :description "YASnippet is a template system for Emacs."
-                  :type github
-                  :pkgname "capitaomorte/yasnippet"
-                  :features "yasnippet"
-                  :compile "yasnippet.el")
-          el-get-sources)
+https://github.com/dimitri/el-get for instructions.
 
 ## Use `yas-minor-mode` on a per-buffer basis
 
-To use YASnippet as a non-global minor mode, replace `(yas-global-mode 1)` with
-`(yas-reload-all)` to load the snippet tables. Then add a call to
-`(yas-minor-mode)` to the major-modes where you to enable YASnippet.
+To use YASnippet as a non-global minor mode, don't call
+`yas-global-mode`; instead call `yas-reload-all` to load the snippet
+tables and then call `yas-minor-mode` from the hooks of major-modes
+where you want YASnippet enabled.
 
-    (add-hook 'prog-mode-hook
-              '(lambda ()
-                 (yas-minor-mode)))
+    (yas-reload-all)
+    (add-hook 'prog-mode-hook #'yas-minor-mode)
 
 # Where are the snippets?
 
@@ -112,22 +99,21 @@ should be added like this to `yas-snippet-dirs`:
 # Manual, issues etc
 
 Please refer to the comprehensive [documentation][docs] for full
-customization and support.  If you find a bug in the code or in the
+customisation and support.  If you find a bug in the code or in the
 documentation, please report it on [the GitHub issue tracker][issues].
 
 ## Important note regarding bug reporting
 
 Your bug reports are very valuable.
 
-The most important thing when reporting bugs is making sure that the
-developer has a way to reproduce the problem exactly like it happened
-to you.
+The most important thing when reporting bugs is making sure that we have
+a way to reproduce the problem exactly like it happened to you.
 
-To do this, he needs to rule out interference from external factors
-like other Emacs extensions or other Lisp-side code.
+To do this, we need to rule out interference from external factors
+like other Emacs extensions or your own customisations.
 
-Here's an example that "sandboxes" an emacs just for reproducing the
-bug.
+Here's an example report that "sandboxes" an Emacs session just for 
+reproducing a bug.
 
 ```
 $ emacs --version
@@ -147,9 +133,12 @@ OR
 I can't get yasnippet to load because frankinbogen!
 ```
 
+Using `emacs -Q` or temporarily moving your `.emacs` init file to the side 
+is another way to achieve good reproducibility.
+
 Here's a
 [another example](https://github.com/capitaomorte/yasnippet/issues/318)
-of a bug report. It has everything needed for a sucessfull analysis
+of a bug report. It has everything needed for a successful analysis
 and speedy resolution.
 
 Also, don't forget to state the Emacs version (use `M-x emacs-version`) and
@@ -159,9 +148,8 @@ do `git log -1` in the dir).
 Any more info is welcome, but don't just paste a backtrace or an error
 message string you got, unless we ask for it.
 
-
 There is also a [YASnippet google group][forum]. I will keep the group
-open for reference and for discussion among users, unfortunately I
+open for reference and for discussion among users. Unfortunately I
 can't guarantee a timely response, so maybe it's better to create a
 github issue clearly marking your intent (user support/bug/feature
 request).