<% Inochi.book :WordCount, self %>

<%# include intro.erb #%>
<%# include setup.erb #%>
<%# include theory.erb #%>
<%# include usage.erb #%>
<%# include history.erb #%>

<% chapter "Introduction" do %>
  <% project_summary do %>
    > TODO: explain the purpose of your project

    ****<%= $project %>**** is a __________ that __________.
  <% end %>

  > TODO: explain why your project is important

  **<%= $project %>** is exciting because:
  * It lets you __________.
  * Its core contains less than __________ lines of code.
  * It __________.

  > TODO: explain why your project is better than its competitors

  These features distinguish **<%= $project %>** from the competition:
  * [competitor 1](http://)
  * [competitor 2](http://)
  * [competitor 3](http://)

  <% paragraph "Etymology" do %>
    > TODO: explain the meaning of the name of your project
  <% end %>

  <% section "Logistics" do %>
    * <%= xref "History", "Release notes" %> --- history of project releases.
    * [Source code](http://github.com/sun/<%= $program %>) --- obtain via [Git](http://git.or.cz) or browse online.
    * [API reference](api/index.html) --- documentation for source code.

    To get help or provide feedback, simply
    <%= xref "License", "contact the author(s)" %>.

    <% paragraph "Version numbers" do %>
      **<%= $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>
    <% end %>
  <% end %>

  <% section "License" do %>
    <%# include ../LICENSE #%>
  <% end %>

  <% section "Credits" do %>
    > TODO: give attribution to your predecessors and contributors
  <% end %>
<% end %>

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

<% chapter "Theory of operation" do %>
  > TODO: explain how your project does what it does
<% end %>

<% chapter "Usage" do %>
  <% section "Command-line interface" do %>
    When you run this command:

        <%= $program %> --help

    You will see this output:

    <pre><%= verbatim `ruby bin/#{$program} --help` %></pre>

    > TODO: explain the command-line arguments
  <% end %>

  <% section "Ruby library interface" do %>
    > TODO: explain how to use your project's Ruby library
    >       from inside another Ruby program or library
  <% end %>

  <% section "Tutorial" do %>
    This tutorial shows how **<%= $project %>** is used to __________.

    > TODO: give examples for doing common tasks
  <% end %>

  > TODO: explain how to do more (advanced) things
<% end %>

<% chapter "History" do %>
  > TODO: put a brief history about your project here

  <% project_history do %>
    > TODO: put release notes for your project
    >       here -- newest first, oldest last.

    <% section "Version 0.0.0 (2009-01-19)" do %>
      > TODO: write a short summary of the changes in this release

      This release changes __________, adds __________, and fixes __________.

      <% paragraph "Contributor kudos" do %>
        > TODO: list everyone who contributed to this
        >       release and what their contribution was

        * __________ contributed __________ which __________.

        * __________ fixed __________ which __________.

        * __________ added __________ which __________.
      <% end %>

      <% paragraph "Incompatible changes" do %>
        > TODO: list all backward-incompatible changes in this release

        * __________ has been __________ to __________.

        * __________.

        * __________.
      <% end %>

      <% paragraph "New features" do %>
        > TODO: list new features added in this release

        * __________.

        * __________.

        * __________.
      <% end %>

      <% paragraph "Bug fixes" do %>
        > TODO: describe all bugs that are fixed in this release

        * __________ was __________.

        * __________ were __________.

        * __________ did __________.
      <% end %>

      <% paragraph "Housekeeping" do %>
        > TODO: list the refactorings, clean ups, and other
        >       improvements that were done for this release

        * __________.

        * __________.

        * __________.
      <% end %>
    <% end %>
  <% end %>
<% end %>

In order to automate the announcement of releases, Inochi needs to know your login information for the RAA (Ruby Application Archive) and RubyForum, which serves as a gateway to the ruby-talk mailing list.

This information is expected to be stored in a ~/.config/inochi/logins.yaml file (this location can be overridden by passing the :logins_file option to the Inochi.rake() method), where ~ denotes the path to your home directory. This file is a YAML document containing the following parameters:

www.ruby-forum.com:
  user: YOUR_USERNAME_HERE
  pass: YOUR_PASSWORD_HERE

raa.ruby-lang.org:
  pass: YOUR_PASSWORD_HERE

For better security, you should ensure that this file is only readable and writable by you and is not accessible by anyone else. In a UNIX environment, this can be accomplished by running the following command:

# chmod 0600 ~/.config/inochi/logins.yaml