@@ -2,25 +2,24 @@ 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). -To use these files you'll need to copy them to the rdoc folder in the directory for your local ruby install. +These are mac specific instructions. You'll have to figure it out if you're on windows. -I only have tested this on a mac so the instructions are mac specific for now. +== Installation -Your local rdoc (and ruby install) should be here... or something similar -/usr/local/lib/ruby/1.8/rdoc +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 -1) Unzip the jaxdoc package -2) Open the terminal (command line) and switch to the new jaxdoc dir that was created when you unzipped the package -3) copy the file 'ajax_generator.rb' to the 'generators' directory in your rdoc folder - >sudo cp ajax_generator.rb /usr/local/lib/ruby/1.8/rdoc/generators +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) copy the template files (and directory) over to the template directory inside the generators directory - >sudo cp -R ajax /usr/local/lib/ruby/1.8/rdoc/generators/template +4) Switch over to the directory where you want to run this rdoc template and run the following command + * rdoc --fmt ajax -5) Switch over to the directory where you want to run this rdoc template and use the -fmt command to run the this template - >rdoc --fmt ajax - -6) This should start the generator and you'll have your new rdoc template in no-time! It should be in a folder called "doc" +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 @@ -29,7 +28,4 @@ Thanks! 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) - - - +export RUBYLIB=~/brain/rails/src/jaxdoc_0.0.1 (for example) \ No newline at end of file README f27242f1a4beef4d1788d48356024e3c03855e28 John Nunemaker nunemaker@gmail.com http://github.com/jnunemaker/ajax-rdoc/commit/f57c8802585dfd621c5b460eb291752cec803dd9 f57c8802585dfd621c5b460eb291752cec803dd9 2008-06-30T13:19:46-07:00 2008-06-30T13:19:46-07:00 updated readme 61e0fea137ad36dd0e0863e3555ddb16841d9d6e John Nunemaker nunemaker@gmail.com