doc/setup.erb in inochi-0.3.0 vs doc/setup.erb in inochi-1.0.0
- old
+ new
@@ -1,20 +1,24 @@
-<% chapter "Setup" do %>
- <% section "Requirements" do %>
- Your system needs the following software to run **<%= $project %>**.
+%#--
+%# Copyright 2009 Suraj N. Kurapati
+%# See the 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 or 1.8.7 is required. |
- | [RubyGems](http://rubygems.org) | Ruby packaging system | Version 1.x.x is required. |
+ | [RubyGems](http://rubygems.org) | Ruby packaging system | Version 1.3.1 or newer is required. |
| [Lynx](http://lynx.isc.org) | Text-mode web browser | Version 2.8.6 or newer is required to convert HTML into plain text. |
- <% end %>
- <% section "Installation" do %>
- You can install **<%= $project %>** by running this command:
+ %|section "Installation"
+ You can install <%= $project %> by running this command:
- gem install -f <%= $program %>
+ gem install <%= $program %> --development
To check whether the installation was sucessful, run this command:
<%= $program %> --version
@@ -22,32 +26,29 @@
<pre><%= `ruby bin/#{$program} --version` %></pre>
If you do not see such output, you may
<%= xref "License", "ask the author(s)" %> for help.
- <% end %>
- <% section "Manifest" do %>
- You will see the following items inside **<%= $project %>**'s installation
+ %|section "Manifest"
+ You will see the following items inside <%= $project %>'s installation
directory, whose path you can determine by running this command:
<%= $program %> --version
* <tt>bin/</tt>
- * <tt><%= $program %></tt> --- the main **<%= $project %>** executable.
+ * <tt><%= $program %></tt> --- the main <%= $project %> executable.
* <tt>lib/</tt>
- * <tt><%= $program %>.rb</tt> --- the main **<%= $project %>** library.
+ * <tt><%= $program %>.rb</tt> --- the main <%= $project %> library.
* <tt>doc/</tt>
* <tt>api/</tt> --- API reference documentation.
* <tt>index.erb</tt> --- source of this user manual.
* <tt>lang/</tt> --- translations of language phrases.
* <tt>LICENSE</tt> --- copyright notice and legal conditions.
- <% end %>
-<% end %>