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


  %|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>