From 3fc22c2955722a9e39d87b205fcf5095f3807bb7 Mon Sep 17 00:00:00 2001 From: Neozaru Date: Mon, 2 Jun 2014 22:07:20 +0200 Subject: [PATCH] Updated README for documentation --- README | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README b/README index 87a89c587..1ed19f898 100644 --- a/README +++ b/README @@ -29,4 +29,20 @@ cd build cmake -G "Visual Studio 11 Win64" .. And then do Build. -Good luck! \ No newline at end of file +Good luck! + + +Build documentation (Doxygen) : +Pequired Packages: +* doxygen +* graphviz (optional) + +From root code directory, execute : + + doxygen Doxyfile + +If you have installed *graphviz*, you can also generate in-doc diagrams : + + HAVE_DOT=YES doxygen Doxyfile + +The output will go in **doc/html/**