From 7263020d74bd006e1e066b317fad733d4e4af19c Mon Sep 17 00:00:00 2001 From: Snaipe Date: Wed, 23 Sep 2015 14:09:49 +0200 Subject: [PATCH] Updated documentation intro [ci skip] --- doc/intro.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/intro.rst b/doc/intro.rst index e2a1125..5d2792e 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -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+).