From e777098c4787157827e80998e55039b39f97d17b Mon Sep 17 00:00:00 2001 From: Dan Middleton Date: Wed, 4 Apr 2018 16:42:42 -0500 Subject: [PATCH] Add doxygen instructions to readme Signed-off-by: Dan Middleton --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e8687d41..4e4ccd6a 100644 --- a/README.md +++ b/README.md @@ -276,15 +276,21 @@ Then, to compile the library, tests, and profiling harness, run this within the $ make +To compile and run the tests for this library, run: + + $ make check + To create the HTML documentation, run $ make doc and then view the resulting `README.html` (which contains the very text you are reading now). -To compile and run the tests for this library, run: +To create the source code documentation install doxygen and graphviz. From the root of the repo run: - $ make check + $ doxygen doxygen.conf + +With a web browser open index.html from the resulting doxygen directory. ### Using libsnark as a library