Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add doxygen instructions to readme #107

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add doxygen instructions to readme #107

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down