aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorNoodleDoodleNoodleDoodleNoodleDoodleNoo <xeven77@outlook.com>2014-06-16 03:32:09 -0700
committerNoodleDoodleNoodleDoodleNoodleDoodleNoo <xeven77@outlook.com>2014-06-16 03:32:09 -0700
commit8fc42a21fc8ff4528c59e206b24d974982332964 (patch)
treea0d9934ca8675afe4bbe5594f2b9694867eb73b6 /README
parentRevert "Update slow-hash.c" (diff)
parentMerge pull request #33 from mikezackles/arch_linux_build_fixes (diff)
downloadmonero-8fc42a21fc8ff4528c59e206b24d974982332964.tar.xz
Merge branch 'master' of https://github.com/monero-project/bitmonero
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/**