Updated README for documentation
This commit is contained in:
parent
b09eea548a
commit
3fc22c2955
18
README
18
README
|
@ -29,4 +29,20 @@ cd build
|
||||||
cmake -G "Visual Studio 11 Win64" ..
|
cmake -G "Visual Studio 11 Win64" ..
|
||||||
|
|
||||||
And then do Build.
|
And then do Build.
|
||||||
Good luck!
|
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/**
|
||||||
|
|
Loading…
Reference in New Issue