Adding information about jsdoc3 dependency

2013-03-08 19:19:14 +01:00
parent 0a13344668
commit 06de786b98
1 changed files with 4 additions and 0 deletions
--- a/readme.md
+++ b/readme.md
@@ -79,8 +79,12 @@ Then:

 ## Run the precommit hook before pushing a commit:

+First, install the latest version of [JSDoc3](https://github.com/jsdoc3/jsdoc). Then:
+
    $ ./build.py precommit

+This makes sure that your commit won't break the build. It also runs JSDoc3 to make sure that there are no invalid API doc directives. 
+
 ## Add examples

 The examples are located in the `examples` directory. Adding a new example