Contents

%#--
%# Copyright 2008 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 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.   |

  %|section "Installation"
    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:

    <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 "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>lib/</tt>

      * <tt><%= $program %>.rb</tt> --- the main <%= $project %> library.

      * <tt><%= $program %>/</tt>

        * <tt>ixp.rb</tt> - pure Ruby client for the [9P2000 protocol](<%= p9p_url %>)

    * <tt>doc/</tt>

      * <tt>api/</tt> --- API reference documentation.

      * <tt>index.erb</tt> --- source of this user manual.

    * <tt>LICENSE</tt> --- copyright notice and legal conditions.

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
rumai-2.1.0	doc/setup.erb
rumai-3.0.0	doc/setup.erb