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

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