%#-- %# Copyright 2009 Suraj N. Kurapati %# See the LICENSE file for details. %#++ % api_url = './api/index.html' % repo_url = 'http://github.com/sunaku/' + $program % repo_scm = '[Git](http://git-scm.com)' %|chapter "Introduction" %|project <%= $project %> is an [eRuby template](http://en.wikipedia.org/wiki/ERuby) processsor that facilitates debugging, reduces markup, and improves composability of eRuby templates. <%= $project %> is exciting because: * It reports correct line numbers in stack traces. * It can infer <%% end %> based on indentation. * It can unindent block content hierarchically. * It completely silences code-only eRuby directives. * It is implemented in <%= `sloccount lib`[/^\d+/] %> lines of pure Ruby. These features distinguish <%= $project %> from the competition: * [Erubis](http://www.kuwata-lab.com/erubis/) * [eruby](http://modruby.net/en/) * [ERB](http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/) %|paragraph "Etymology" <%= $project %> stands for *embe*dded *r*uby. %|section "Logistics" * <%= xref "History", "Release notes" %> --- history of project releases. * [Source code](<%= repo_url %>) --- obtain via <%= repo_scm %> or browse online. * [API reference](<%= api_url %>) --- documentation for source code. * [Project home](<%= $website %>) --- the <%= $project %> project home page. To get help or provide feedback, simply <%= xref "License", "contact the author(s)" %>. %|paragraph "Version numbers" <%= $project %> releases are numbered in *major.minor.patch* form according to the [RubyGems rational versioning policy](http://www.rubygems.org/read/chapter/7), which can be summarized thus:
What increased in the version number? | The increase indicates that the release: | ||
Is backward compatible? | Has new features? | Has bug fixes? | |
---|---|---|---|
major | No | Yes | Yes |
minor | Yes | Yes | Yes |
patch | Yes | No | Yes |