1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
|
Setup
=====
Prerequisites
-------------
The library is supported on Linux, macOS, FreeBSD, and Windows.
The following compilers are supported to compile both the library and the tests:
* GCC 4.9+ (Can be relaxed to GCC 4.6+ when not using C++)
* Clang 3.4+
* MSVC 14+ (Included in Visual Studio 2015 or later)
Building from source
--------------------
First, install dependencies:
* C/C++ compiler
* Meson, Ninja
* CMake (for subprojects)
* pkg-config
* libffi (libffi-dev)
* libgit2 (libgit2-dev)
Other runtime dependencies will be bundled if they are not available on the
system (BoxFort, debugbreak, klib, nanomsg, nanopb).
Clone this repository:
.. code-block:: bash
$ git clone --recursive https://github.com/Snaipe/Criterion
Then, run the following commands to build Criterion:
.. code-block:: bash
$ meson build
$ ninja -C build
Installing the library and language files (Linux, macOS, FreeBSD)
----------------------------------------------------------------
Run with an elevated shell:
.. code-block:: bash
$ ninja -C build install
On Linux systems, update the dynamic linker runtime bindings:
.. code-block:: bash
$ ldconfig
Usage
-----
To compile your tests with Criterion, you need to make sure to:
1. Add the include directory to the header search path
2. Install the library to your library search path
3. Link Criterion to your executable.
This should be all you need.
|