= \RDoc - Ruby Documentation System

* {RDoc Project Page}[http://rubyforge.org/projects/rdoc/]
* {RDoc Documentation}[http://rdoc.rubyforge.org/]
* {RDoc Bug Tracker}[http://rubyforge.org/tracker/?atid=2472&group_id=627&func=browse]

== DESCRIPTION:

RDoc produces HTML and command-line documentation for Ruby projects.  RDoc
includes the +rdoc+ and +ri+ tools for generating and displaying online
documentation.

See RDoc for a description of RDoc's markup and basic use.

== SYNOPSIS:

To generate HTML documentation:

  rdoc .

To generate documentation programmatically:

  gem 'rdoc'
  require 'rdoc/rdoc'
  # ... see RDoc

== BUGS:

If you find a bug, please report it at the RDoc project's
tracker[http://rubyforge.org/tracker/?group_id=627] on RubyForge

== LICENSE:

RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers.
Portions (c) 2007-2010 Eric Hodel.  Portions copyright others, see individual
files for details.

It is free software, and may be redistributed under the terms specified in
LICENSE.txt.

== WARRANTY:

This software is provided "as is" and without any express or implied
warranties, including, without limitation, the implied warranties of
merchantibility and fitness for a particular purpose.