diff --git a/README.md b/README.md index 68174012..5af84f03 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,13 @@ $ make $ make install ``` +### build documentation +``` +$ cd xo-unit +$ cmake --build .build -- sphinx +``` +When this completes, point local browser to `xo-unit/.build/docs/sphinx/index.html`. + ### build for unit test coverage ``` $ cd xo-unit