doc/setup.erb in ember-0.0.0 vs doc/setup.erb in ember-0.0.1
- old
+ new
@@ -1,20 +1,26 @@
%#--
-%# Copyright 2009 Suraj N. Kurapati
-%# See the LICENSE file for details.
+%# Copyright protects this work.
+%# See LICENSE file for details.
%#++
+
%|chapter "Setup"
+
+
%|section "Requirements"
+
Your system needs the following software to run <%= $project %>.
| Software | Description | Notes |
| -------- | ----------- | ----- |
| [Ruby](http://ruby-lang.org) | Ruby language interpreter | Version 1.8.6, 1.8.7, and 1.9.1 have been tested successfully. |
| [RubyGems](http://rubygems.org) | Ruby packaging system | Version 1.3.1 or newer is required. |
+
%|section "Installation"
+
You can install <%= $project %> by running this command:
gem install <%= $program %>
To check whether the installation was sucessful, run this command:
@@ -25,5 +31,48 @@
<pre><%= verbatim `ruby bin/#{$program} --version` %></pre>
If you do not see such output, you may
<%= xref "License", "ask the author(s)" %> for help.
+
+
+ %|section "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:
+
+ <table markdown="1">
+ <thead>
+ <tr>
+ <td rowspan="2">What increased in the version number?</td>
+ <td colspan="3">The increase indicates that the release:</td>
+ </tr>
+ <tr>
+ <th>Is backward compatible?</th>
+ <th>Has new features?</th>
+ <th>Has bug fixes?</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th>major</th>
+ <td style="background-color: #FFE4E1;">No</td>
+ <td>Yes</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>minor</th>
+ <td>Yes</td>
+ <td>Yes</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>patch</th>
+ <td>Yes</td>
+ <td style="background-color: #FFE4E1;">No</td>
+ <td>Yes</td>
+ </tr>
+ </tbody>
+ </table>
+