From 5edc9786e497fafc9f9ff4151db4d1e59aacb269 Mon Sep 17 00:00:00 2001 From: Marc Weber Date: Mon, 29 Apr 2013 20:15:42 +0200 Subject: [PATCH] document how version differences could be coped with --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index 6846edb..0cd0f90 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,33 @@ Historical notes unfortunately abandoned the project. [Rok Garbas][3] is now maintaining a [fork][4] of the project in hopes of improving the existing code base. +Versions / dialects / .. +======================== +There are some issues, such as newer language versions may require other +snippets than older. If this exists we currently recommend doing this: + +add snippets/ruby.snippets (common snippets) +add snippets/ruby-1.8.snippets (1.8 only) +add snippets/ruby-1.9.snippets (1.9 only) + +then configure github.com/garbas/vim-snipmate this way: + + let g:snipMate = {} + let g:snipMate.scope_aliases = {} + let g:snipMate.scope_aliases['ruby'] = 'ruby,ruby-rails,ruby-1.9' + +or github.com/MarcWeber/UltiSnips this way: + + + let g:UltiSnips = {} + + let g:UltiSnips.snipmate_ft_filter = { + \ 'default' : {'filetypes': ["FILETYPE"] }, + \ 'ruby' : {'filetypes': ["ruby", "ruby-rails", "ruby-1.9"] }, + + +If it happens that you work on a project requiring ruby-1.8 snippets instead, +consider using vim-addon-local-vimrc and override the filetypes. Language maintainers -------------------- @@ -76,6 +103,11 @@ Language maintainers No one can really be proficient in all programming languages. If you would like to maintain snippets for a language, please get in touch. +Notes: People are interested in snippets - and their interest may stop again +at will. So its ok if people maintain a language only for a short period of +time - or jump in and get things done - don't let the flow stop :) +vim-snippets is not like the "linux kernel". + * Python - [honza](http://github.com/honza) * Javascript - [honza](http://github.com/honza) * HTML Django - [honza](http://github.com/honza)