From c8c3883569931dc3e284ec01ebeb889d0a972641 Mon Sep 17 00:00:00 2001 From: Irlan Robson Date: Sat, 1 Sep 2018 18:56:28 -0300 Subject: [PATCH] Update readme.md --- readme.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 235c25f..6c55963 100644 --- a/readme.md +++ b/readme.md @@ -47,6 +47,15 @@ libglu1-mesa-dev I don't run Mac currently and therefore can't test the build system in this platform. +## Documenting + +* Grab [Doxygen](http://www.doxygen.org) from http://www.doxygen.org +* Say the following on the command line: doxygen doxyfile +* Open doc/api/html/index.html + +User manual is a work in progress. Meanwhile, code comments are the best way to learn how to use +Bounce. + ## Dependencies * [Triangle](http://www.cs.cmu.edu/~quake/triangle.html) @@ -104,6 +113,6 @@ Below are the external dependencies for the Testbed. If you don't care about the * Mouse picking * premake build system -### Documentation +## Documentation * Doxygen API documentation