# Check [![Linux Build Status](https://github.com/libcheck/check/workflows/linux/badge.svg)](https://github.com/libcheck/check/actions?query=workflow%3Alinux) [![OSX Build Status](https://github.com/libcheck/check/workflows/osx/badge.svg)](https://github.com/libcheck/check/actions?query=workflow%3Aosx) [![Windows Build Status](https://github.com/libcheck/check/workflows/windows/badge.svg)](https://github.com/libcheck/check/actions?query=workflow%3Awindows)

## Table of Contents * [About](#about) * [Installing](#installing) * [Linking](#linking) * [Packaging](#packaging) ## About Check is a unit testing framework for C. It features a simple interface for defining unit tests, putting little in the way of the developer. Tests are run in a separate address space, so Check can catch both assertion failures and code errors that cause segmentation faults or other signals. The output from unit tests can be used within source code editors and IDEs. See https://libcheck.github.io/check for more information, including a tutorial. The tutorial is also available as `info check`. ## Installing Check has the following dependencies: * [automake](https://www.gnu.org/software/automake/)-1.9.6 (1.11.3 on OS X if you are using /usr/bin/ar) * [autoconf](https://www.gnu.org/software/autoconf/)-2.59 * [libtool](https://www.gnu.org/software/libtool/)-1.5.22 * [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/)-0.20 * [texinfo](https://www.gnu.org/software/texinfo/)-4.7 (for documentation) * tetex-bin (or any texinfo-compatible TeX installation, for documentation) * POSIX [sed](https://en.wikipedia.org/wiki/Sed) The versions specified may be higher than those actually needed. ### autoconf $ autoreconf --install $ ./configure $ make $ make check $ make install $ sudo ldconfig in this directory to set everything up. autoreconf calls all of the necessary tools for you, like autoconf, automake, autoheader, etc. If you ever change something during development, run autoreconf again (without --install), and it will perform the minimum set of actions necessary. Check is installed to `/usr/local/lib` by default. ldconfig rebuilds the linker cache so that newly installed library file is included in the cache. ### cmake $ mkdir build $ cd build $ cmake ../ $ make $ CTEST_OUTPUT_ON_FAILURE=1 make test ## Linking Check uses variadic macros in check.h, and the strict C90 options for gcc will complain about this. In gcc 4.0 and above you can turn this off explicitly with `-Wno-variadic-macros`. In a future API it would be nice to eliminate these macros. ## Packaging Check is available packaged for the following operating systems:

[![Packaging status](https://repology.org/badge/vertical-allrepos/check.svg)](https://repology.org/project/check/versions)