Skip to content

Commit 7afed49

Browse files
committed
Updated README documentation.
1 parent 4be2b5a commit 7afed49

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,11 @@ system.
6161
Inside the cpp-netlib directory, you can issue the following statements to
6262
configure and generate the Makefiles, and build the tests::
6363

64-
$ cd ~/cpp-netlib # we're assuming it's where cpp-netlib is
65-
$ cmake ~/cpp-netlib-build \ # cmake is built out of source
64+
$ cd ~/cpp-netlib-build # cmake is built out of source
65+
$ cmake ~/cpp-netlib \ # we're assuming it's where cpp-netlib is
6666
> -DCMAKE_BUILD_TYPE=Debug \
6767
> -DCMAKE_C_COMPILER=clang \
68-
> -DCMAKE_CXX_COMPILER=clang++ \
69-
> .
68+
> -DCMAKE_CXX_COMPILER=clang++
7069

7170
Once CMake is done with generating the Makefiles and configuring the project,
7271
you can now build the tests and run them::
@@ -79,6 +78,13 @@ If for some reason some of the tests fail, you can send the files in
7978
``Testing/Temporary/`` as attachments to the cpp-netlib `developers mailing
8079
list`_.
8180

81+
API documentation can be generated by running the following command::
82+
83+
$ cd ~/cpp-netlib-build
84+
$ make doc
85+
86+
The HTML output can be found in the ``html`` subdirectory.
87+
8288
.. _`developers mailing list`: cpp-netlib@googlegroups.com
8389

8490
Running Tests

0 commit comments

Comments
 (0)