aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authormonero-project <sempre.amaro@gmail.com>2014-06-04 10:16:24 -0400
committermonero-project <sempre.amaro@gmail.com>2014-06-04 10:16:24 -0400
commitcf8ac2c8f1b5733c1cf9ddaa814fca249697dbaa (patch)
treef49ff03e793a451e324e0b913b0d762f627e8bc5 /README
parentMerge pull request #21 from Neozaru/master (diff)
parentMerge pull request #2 from monero-project/master (diff)
downloadmonero-cf8ac2c8f1b5733c1cf9ddaa814fca249697dbaa.tar.xz
Merge pull request #22 from Neozaru/master
Added Doxyfile for future documentation
Diffstat (limited to 'README')
-rw-r--r--README18
1 files changed, 17 insertions, 1 deletions
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/**