Sha256: af00a56f32af30a9d12216f1d918123f57597dc8bd8740a3e81e0e2b9b14201b

Contents?: true

Size: 1.8 KB

Versions: 2

Compression:

Stored size: 1.8 KB

Contents

<% 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.7 is required. |
    | [RubyGems](http://rubygems.org) | Ruby packaging system     | Version 1.3.1 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:

    <pre><%= verbatim `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
    directory, whose path you can determine by running this command:

        <%= $program %> --version

    > TODO: list important files your project provides here

    * <tt>bin/</tt>

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

    * <tt>lib/</tt>

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

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

        > TODO: list sub-libraries your project provides here

    * <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.
  <% end %>
<% end %>

Version data entries

2 entries across 2 versions & 2 rubygems

Version Path
testing_please_ignore2-0.0.0 doc/setup.erb
testing_please_ignore-0.0.0 doc/setup.erb