diff --git a/README.md b/README.md index f99231c..fc308e3 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,17 @@ implementation with the primary goal of learning. * FLINT (compiled with gmp and mpfr) * glib-2.0 * lz4 (https://code.google.com/p/lz4) +* cunit (for the tests only) * pkgconfig (for the build only) ### Compiling the library Run ```make``` to build. +### Running the tests + +Run ```make check``` to run the test suite. + ### Installing the library Run ```make install``` to install. diff --git a/include/doxygen.dox b/include/doxygen.dox index 3ec468c..7ea7ffb 100644 --- a/include/doxygen.dox +++ b/include/doxygen.dox @@ -32,10 +32,12 @@ This library was written for Linux systems. Support for windows will not be adde \* FLINT-2.4.3 or later (compiled with gmp and mpfr) \* glib-2.0 \* lz4 + \* cunit (for the tests only) \* pkg-config (for the build only) \section install_sec Installation \* make + \* make check (optional, runs the test suite) \* make install \section usage Usage diff --git a/src/doxygen.dox b/src/doxygen.dox index 9173bf9..6fa5fa8 100644 --- a/src/doxygen.dox +++ b/src/doxygen.dox @@ -22,10 +22,12 @@ This library was written for Linux systems. Support for windows will not be adde \* FLINT-2.4.3 or later (compiled with gmp and mpfr) \* glib-2.0 \* lz4 + \* cunit (for the tests only) \* pkg-config (for the build only) \section install_sec Installation \* make + \* make check (optional, runs the test suite) \* make install \section usage Usage