jnunemaker / ajax-rdoc forked from breakpointer/ajax-rdoc

Rdoc template and generator for Ruby source code that uses javascript to make searching for methods and classes very easy.

This URL has Read+Write access

name age
history
message
file README Mon Jun 30 13:19:46 -0700 2008 updated readme [jnunemaker]
file Rakefile Mon Jun 30 11:43:46 -0700 2008 added install and uninstall rake tasks to make ... [jnunemaker]
directory rdoc/ Mon Jun 30 13:13:31 -0700 2008 pimped the ajax template to use the quicksilver... [jnunemaker]
directory tasks/ Mon Jun 30 11:43:46 -0700 2008 added install and uninstall rake tasks to make ... [jnunemaker]
README
README for jaxdoc - the javascript enhanced rdoc template

The files included in this first release allow you to create a javascript enhanced rdoc (similar to what is on 
www.railsbrain.com right now).

These are mac specific instructions. You'll have to figure it out if you're on windows.

== Installation

1) Get the files 
    * tarball: http://github.com/breakpointer/ajax-rdoc/tarball/master)
    * git: git clone git://github.com/breakpointer/ajax-rdoc.git
    
2) cd into the new ajax-rdoc directory

3) Install the generator and templates into your version of rdoc
    * RDOC=/usr/local/lib/ruby/1.8/rdoc rake install
    * If you are using macports ruby you can just rake install

4) Switch over to the directory where you want to run this rdoc template and run the following command
    * rdoc --fmt ajax

5) This should start the generator and you'll have your new rdoc template in no-time! It should be in a folder called 
"doc"

Should you have any problems (or questions) feel free to contact me at blchamberlain+rb@gmail.com

Thanks!
-Brian

Alternatively you can set this env var and run the documentation generator from anyware (ie your home dir)

export RUBYLIB=~/brain/rails/src/jaxdoc_0.0.1 (for example)