Skip to content
Browse files

doc generation instructions

  • Loading branch information...
1 parent fdc5cd3 commit 8c77279eedea9cbdfa61bdcad3cdc453c22733ea @olegp committed Sep 2, 2011
Showing with 4 additions and 0 deletions.
  1. +4 −0 README.md
View
4 README.md
@@ -53,6 +53,10 @@ For more usage examples, please refer to the tests in the [common-node/test](ht
The API reference is available at <http://olegp.github.com/common-node/doc/>
+To generate the documentation, install RingoJS and run:
+
+ ringo-doc -n "Common Node" -s ./lib -d ./doc --file-urls
+
### Tests
To run the unit tests run:

0 comments on commit 8c77279

Please sign in to comment.
Something went wrong with that request. Please try again.