What the...?
==========

A simple script that generates a graph of the ruby class hierarchy.
The script relies on GraphViz[1] for generation of the PNG and HTML map
files.
Take a look at the basic Ruby class hierarchy on the project web site:
http://objectgraph.rubyforge.org/.


Why?
====

Because it's neat. And because the online PickAxe seems to be missing
some graphs. And because many nubys (myself included) don't always know
the Exception inheritance hierarchy. And because I was home sick and
needed something to do (which is a nice excuse why the code may not be
all that great :).

Features:
=========
* Supports multiple layout engines (dot, neato, twopi and circo).
* Supports multiple output formats by GraphViz (PNG, JPEG etc.)
* Errno::... classes can be omitted.
* Clicking on a class node should go to the ruby-doc.org documentation
for that class.

Installation:
=============
* Install GraphViz and make sure that the executables are on the path.
* Grab the graph.rb file (CVS Only at this stage. I'll release a zip
that includes some pics later :)
* Call graph.rb (usage info below)
* Look at the pretty pictures :)


Next on the TODO list:
=====================
* Add capability to generate only partial tree, based on a common base
class (e.g. Exception).
* Add capability to generate a graph based on name-space (e.g. Wx).
* Support links to std-lib classes documentations.

Cheers,
Assaph

[1] http://www.research.att.com/sw/tools/graphviz/