= RDazzle
- home: http://rubyworks.github.com/rdazzle
- work: GitHub - rubyunworks/rdazzle: Razzle Dazzle Your Document Hassle
- talk: http://groups.google/group/rubyworks-mailinglist
== DESCRIPTION
RDazzle is a templating framework and template collection for RDoc.
RDazzle provides a variety of beautiful templates, including enhanced
renditions of some of the most popular designs in use today. And
RDazzle’s component API makes it easy to create your own RDoc
generators.
== RELEASE NOTES
Please see the HISTORY file.
== INSTALLATION
Installing via RubyGems is per the usual:
$ sudo gem install rdazzle
Becuase the version of RDoc included with Ruby is old, be sure to ‘gem
install rdoc’ too.
== USAGE SYNOPSIS
To generate documentation using an RDazzle template, simply use the
+rdoc+ tool as you normally would, specifying the RDazzle template using
-T option.
$ rdoc -T redfish -m README README lib/
RDazzle extends RDoc to recognize the templates that RDazzle will handle
and transfers control to appropriate RDazzle generator accordingly.
If you would like to use RDazzle to create the next great RDoc template,
please jump over to the GitHub site and get in touch.
== COPYING
RDazzle Copyright (c) 2008 Thomas S., MIT License
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
RDazzle would not have been possible without the excellect work of other
brilliant Rubyists. For a list of acknowldegements and copyrights of
borrowed code snippets, please see the COPYING file.
