Yuri D'Elia ae17cef676 Update Catch2 v3.1.1 1 anno fa
..
.conan ae17cef676 Update Catch2 v3.1.1 1 anno fa
.github ae17cef676 Update Catch2 v3.1.1 1 anno fa
CMake ae17cef676 Update Catch2 v3.1.1 1 anno fa
data ae17cef676 Update Catch2 v3.1.1 1 anno fa
docs ae17cef676 Update Catch2 v3.1.1 1 anno fa
examples ae17cef676 Update Catch2 v3.1.1 1 anno fa
extras ae17cef676 Update Catch2 v3.1.1 1 anno fa
fuzzing ae17cef676 Update Catch2 v3.1.1 1 anno fa
src ae17cef676 Update Catch2 v3.1.1 1 anno fa
tests ae17cef676 Update Catch2 v3.1.1 1 anno fa
third_party 7f1bd0f046 cmake: Update Catch2 1 anno fa
tools ae17cef676 Update Catch2 v3.1.1 1 anno fa
.bazelrc ae17cef676 Update Catch2 v3.1.1 1 anno fa
.clang-format 7f1bd0f046 cmake: Update Catch2 1 anno fa
.gitattributes 7f1bd0f046 cmake: Update Catch2 1 anno fa
.gitignore ae17cef676 Update Catch2 v3.1.1 1 anno fa
.gitrepo ae17cef676 Update Catch2 v3.1.1 1 anno fa
BUILD.bazel ae17cef676 Update Catch2 v3.1.1 1 anno fa
CMakeLists.txt ae17cef676 Update Catch2 v3.1.1 1 anno fa
CMakePresets.json ae17cef676 Update Catch2 v3.1.1 1 anno fa
CODE_OF_CONDUCT.md 7f1bd0f046 cmake: Update Catch2 1 anno fa
Doxyfile ae17cef676 Update Catch2 v3.1.1 1 anno fa
LICENSE.txt 7f1bd0f046 cmake: Update Catch2 1 anno fa
README.md ae17cef676 Update Catch2 v3.1.1 1 anno fa
SECURITY.md ae17cef676 Update Catch2 v3.1.1 1 anno fa
WORKSPACE.bazel ae17cef676 Update Catch2 v3.1.1 1 anno fa
appveyor.yml ae17cef676 Update Catch2 v3.1.1 1 anno fa
codecov.yml ae17cef676 Update Catch2 v3.1.1 1 anno fa
conanfile.py ae17cef676 Update Catch2 v3.1.1 1 anno fa
mdsnippets.json ae17cef676 Update Catch2 v3.1.1 1 anno fa
meson.build ae17cef676 Update Catch2 v3.1.1 1 anno fa

README.md

Catch2 logo

Github Releases Linux build status Linux build status MacOS build status Build Status Code Coverage Try online

What's the Catch2?

Catch2 is mainly a unit testing framework for C++, but it also provides basic micro-benchmarking features, and simple BDD macros.

Catch2's main advantage is that using it is both simple and natural. Tests autoregister themselves and do not have to be named with valid identifiers, assertions look like normal C++ code, and sections provide a nice way to share set-up and tear-down code in tests.

Catch2 v3 is being developed!

You are on the devel branch, where the next major version, v3, of Catch2 is being developed. As it is a significant rework, you will find that parts of this documentation are likely still stuck on v2.

For stable (and documentation-matching) version of Catch2, go to the v2.x branch.

For migrating from the v2 releases to v3, you should look at our documentation. It provides a simple guidelines on getting started, and collects most common migration problems.

How to use it

This documentation comprises these three parts:

More