hasufell/pqc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

DOC: add 'make check' to instructions

Browse Source
This commit is contained in:
hasufell 2014-06-28 02:09:07 +02:00
parent 187875e9c7
commit b8fd0c0559
No known key found for this signature in database
GPG Key ID: 220CD1C5BDEED020
3 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -10,12 +10,17 @@ implementation with the primary goal of learning.
* FLINT (compiled with gmp and mpfr) * FLINT (compiled with gmp and mpfr)
* glib-2.0 * glib-2.0
* lz4 (https://code.google.com/p/lz4) * lz4 (https://code.google.com/p/lz4)
* cunit (for the tests only)
* pkgconfig (for the build only) * pkgconfig (for the build only)
### Compiling the library ### Compiling the library
Run ```make``` to build. Run ```make``` to build.
### Running the tests
Run ```make check``` to run the test suite.
### Installing the library ### Installing the library
Run ```make install``` to install. Run ```make install``` to install.

2
include/doxygen.dox
View File

@ -32,10 +32,12 @@ This library was written for Linux systems. Support for windows will not be adde
\* <a href="http://www.flintlib.org">FLINT-2.4.3 or later</a> (compiled with gmp and mpfr) \* <a href="http://www.flintlib.org">FLINT-2.4.3 or later</a> (compiled with gmp and mpfr)
\* <a href="https://developer.gnome.org/glib/stable/">glib-2.0</a> \* <a href="https://developer.gnome.org/glib/stable/">glib-2.0</a>
\* <a href="https://code.google.com/p/lz4">lz4</a> \* <a href="https://code.google.com/p/lz4">lz4</a>
\* <a href="http://cunit.sourceforge.net">cunit</a> (for the tests only)
\* <a href="http://www.freedesktop.org/wiki/Software/pkg-config/">pkg-config</a> (for the build only) \* <a href="http://www.freedesktop.org/wiki/Software/pkg-config/">pkg-config</a> (for the build only)
\section install_sec Installation \section install_sec Installation
\* make \* make
\* make check (optional, runs the test suite)
\* make install \* make install
\section usage Usage \section usage Usage

2
src/doxygen.dox
View File

@ -22,10 +22,12 @@ This library was written for Linux systems. Support for windows will not be adde
\* <a href="http://www.flintlib.org">FLINT-2.4.3 or later</a> (compiled with gmp and mpfr) \* <a href="http://www.flintlib.org">FLINT-2.4.3 or later</a> (compiled with gmp and mpfr)
\* <a href="https://developer.gnome.org/glib/stable/">glib-2.0</a> \* <a href="https://developer.gnome.org/glib/stable/">glib-2.0</a>
\* <a href="https://code.google.com/p/lz4">lz4</a> \* <a href="https://code.google.com/p/lz4">lz4</a>
\* <a href="http://cunit.sourceforge.net">cunit</a> (for the tests only)
\* <a href="http://www.freedesktop.org/wiki/Software/pkg-config/">pkg-config</a> (for the build only) \* <a href="http://www.freedesktop.org/wiki/Software/pkg-config/">pkg-config</a> (for the build only)
\section install_sec Installation \section install_sec Installation
\* make \* make
\* make check (optional, runs the test suite)
\* make install \* make install
\section usage Usage \section usage Usage