stv0g/Criterion
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Updated documentation intro [ci skip]

Browse source
This commit is contained in:
Snaipe 2015-09-23 14:09:49 +02:00
parent 7d4896da07
commit 7263020d74
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/intro.rst
View file

@ -1,8 +1,7 @@
Introduction
============
Criterion is a dead-simple, non-intrusive testing framework for the C
programming language.
Criterion is a dead-simple, non-intrusive unit testing framework for C and C++.
Philosophy
----------
@ -20,12 +19,15 @@ the user would have with other frameworks.
Features
--------
* C99 and C++11 compatible.
* Tests are automatically registered when declared.
* Implements a xUnit framework structure.
* A default entry point is provided, no need to declare a main
unless you want to do special handling.
* Test are isolated in their own process, crashes and signals can be
reported and tested.
* Unified interface between C and C++: include the criterion header and it *just* works.
* Supports parameterized tests and theories.
* Progress and statistics can be followed in real time with report hooks.
* TAP output format can be enabled with an option.
* Runs on Linux, FreeBSD, Mac OS X, and Windows (Compiling with MinGW GCC).
* xUnit framework structure
* Runs on Linux, FreeBSD, Mac OS X, and Windows (Compiling with MinGW GCC and Visual Studio 2015+).