Fork me on GitHub

RDtool -- RD formatter

What's rdtool?

Build Status

RD is Ruby's POD. RDtool is formatter for RD.

RD is multipurpose documentation format created for documentating Ruby and output of Ruby world. You can embed RD into Ruby script. And RD have neat syntax which help you to read document in Ruby script. On the other hand, RD have a feature for class reference.

Download

Stable: Gem and tar.gz is available:

HEAD: GitHub: uwabami/rdtool

install

If you use gem, simply

  $ gem install rdtool

If you don't use gem, download .tar.gz and

  $ tar xvzf rdtool-(version).tar.gz
  $ cd rdtool-(version)
  $ ruby setup.rb    # or sudo ruby setup.rb

enjoy!!

License

GPL-2+ or Ruby's. However, setup.rb is underl LGPL-2.1+

BTS

If you find bugs, comments, ... Please report github issues.

Contact

Current maintainer: Youhei SASAKI (uwabami@gfd-dennou.org)