h1. Ruby DocTest

h1. → 'rubydoctest'


h2. What

Ruby DocTest is a tool that lets you put irb-style tests in your documentation. It’s similar to Python’s doctest, but different in several ways.

h2. Installing

<pre syntax="ruby">sudo gem install rubydoctest</pre>

h2. Wiki, Documentation, Examples

See the "github wiki":http://github.com/tablatom/rubydoctest/wikis

h2. How to submit patches

Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/.

The git repository is <code>http://github.com/tablatom/rubydoctest/tree/master</code> for anonymous access.

h3. Build and test instructions

<pre>cd rubydoctest
rake test:doctest
rake install_gem</pre>

h2. License

This code is free to use under the terms of the MIT license. 

h2. Contact

Comments are welcome. Send an email to "Duane Johnson":mailto:duane.johnson@gmail.com.