<% chapter "Setup" do %> <% section "Requirements" do %> 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 newer is required. | | [RubyGems](http://rubygems.org) | Ruby packaging system | Version 1.3.1 or newer is required. | | [wmii](<%= wmii_url %>) | Window manager | Version 3.6 or newer is required. | <% end %> <% section "Installation" do %> You can install **<%= $project %>** by running this command: gem install <%= $program %> To check whether the installation was sucessful, run this command: <%= $program %> --version If the installation was successful, you will see output like this:
<%= verbatim `ruby bin/#{$program} --version` %>
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 directory, whose path you can determine by running this command: <%= $program %> --version * bin/ * <%= $program %> --- the main **<%= $project %>** executable. * lib/ * <%= $program %>.rb --- the main **<%= $project %>** library. * <%= $program %>/ * ixp.rb - pure Ruby client for the [9P2000 protocol](<%= p9p_url %>) * doc/ * api/ --- API reference documentation. * index.erb --- source of this user manual. * LICENSE --- copyright notice and legal conditions. <% end %> <% end %>