• Release notes — history of project releases.
• Source code — obtain via Git or browse online.
• API reference — documentation for source code.

To get help or provide feedback, simply contact the author(s).

Copyright 2009 Your Name your@email.here

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

TODO: give attribution to your predecessors and contributors

Your system needs the following software to run TestingPleaseIgnore2.

You can install TestingPleaseIgnore2 by running this command:

gem install testing_please_ignore2

To check whether the installation was sucessful, run this command:

testing_please_ignore2 --version

If the installation was successful, you will see output like this:

project: TestingPleaseIgnore2
version: 0.0.0
release: 2009-01-18
website: http://testing_please_ignore2.rubyforge.org
install: /home/sun/tmp/testing_please_ignore2

If you do not see such output, you may ask the author(s) for help.

You will see the following items inside TestingPleaseIgnore2’s installation directory, whose path you can determine by running this command:

testing_please_ignore2 --version

TODO: list important files your project provides here

• bin/

  • testing_please_ignore2 — the main TestingPleaseIgnore2 executable.

• lib/

  • testing_please_ignore2.rb — the main TestingPleaseIgnore2 library.

  • testing_please_ignore2/

    TODO: list sub-libraries your project provides here

• doc/

  • api/ — API reference documentation.

  • index.erb — source of this user manual.

• LICENSE — copyright notice and legal conditions.

When you run this command:

testing_please_ignore2 --help

You will see this output:

TestingPleaseIgnore2 - TODO: put a single line description of your project
here.

TODO: Explain the command-line usage of this program here.

Usage:

  testing_please_ignore2 [Option...] Arg1 Arg2 Arg3...

   --manual, -m:   Show the user manual
  --version, -v:   Print version and exit
     --help, -h:   Show this message

TODO: explain the command-line arguments

TODO: explain how to use your project’s Ruby library from inside another Ruby program or library

This tutorial shows how TestingPleaseIgnore2 is used to _______.

TODO: give examples for doing common tasks

TODO: write a short summary of the changes in this release

This release changes _______, adds____, and fixes____.