A note about generating documentation.

This commit is contained in:
Jim Menard 2008-12-04 17:02:19 -05:00
parent edcac65c44
commit 981ebb3bfd
1 changed files with 9 additions and 0 deletions

9
README
View File

@ -22,6 +22,15 @@ Mongo must be running, of course.
The tests assume that the Mongo database is running on the default port. The tests assume that the Mongo database is running on the default port.
= Documentation
$ rake rdoc
Then open the file doc/index.html. (I need to figure out where to put this on
the Web, or even how to publish this to the Wiki at
http://github.com/jimm/mongo-ruby-driver/wikis automatically.)
= The Code = The Code
Most of this code was transliterated from Geir Magnusson Jr's Java Mongo Most of this code was transliterated from Geir Magnusson Jr's Java Mongo