aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNeozaru <neozaru@mailoo.org>2014-06-02 22:07:20 +0200
committerNeozaru <neozaru@mailoo.org>2014-06-02 22:07:20 +0200
commit3fc22c2955722a9e39d87b205fcf5095f3807bb7 (patch)
tree8b271decc6629c604f2e97c6da426d7efacbff05
parentAdded Doxyfile for (uggly) documentation generation (diff)
downloadmonero-3fc22c2955722a9e39d87b205fcf5095f3807bb7.tar.xz
Updated README for documentation
-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/**