Permalink
Browse files

Add instructions to generate documentation

  • Loading branch information...
1 parent 390609b commit c1629e17cd9764a257d0668e9f3599107e92f44b @astrada committed Dec 7, 2011
Showing with 8 additions and 0 deletions.
  1. +8 −0 README.md
View
@@ -60,6 +60,14 @@ To build the tests, execute
To run the tests, see [tests README](src/test/README.md).
+To generate the documentation, execute
+
+ $ cd src
+ $ ocamlbuild gapi/gapi.docdir/index.html
+
+Then you can access the HTML documentation starting from
+`src/gapi.docdir/index.html`.
+
### Usage
See [auth examples](src/examples/auth) for some examples of how to use

0 comments on commit c1629e1

Please sign in to comment.