Clare Macrae
2dc5a5f402
Prepare to prevent Catch2 v3's tests from being run, and CTest targets from being added, if Catch2 is configured as a sub-project. (#2205)
|
3 years ago | |
|---|---|---|
| .conan | 3 years ago | |
| .github | 3 years ago | |
| CMake | 3 years ago | |
| data | 4 years ago | |
| docs | 3 years ago | |
| examples | 3 years ago | |
| extras | 3 years ago | |
| fuzzing | 3 years ago | |
| src | 3 years ago | |
| tests | 3 years ago | |
| third_party | 3 years ago | |
| tools | 3 years ago | |
| .clang-format | 3 years ago | |
| .gitattributes | 5 years ago | |
| .gitignore | 3 years ago | |
| .travis.yml | 3 years ago | |
| BUILD.bazel | 3 years ago | |
| CMakeLists.txt | 3 years ago | |
| CODE_OF_CONDUCT.md | 6 years ago | |
| Doxyfile | 3 years ago | |
| LICENSE.txt | 7 years ago | |
| README.md | 3 years ago | |
| WORKSPACE | 3 years ago | |
| appveyor.yml | 3 years ago | |
| codecov.yml | 3 years ago | |
| conanfile.py | 3 years ago | |
| mdsnippets.json | 3 years ago |
README.md
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.
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.
How to use it
This documentation comprises these three parts:
- Why do we need yet another C++ Test Framework?
- Tutorial - getting started
- Reference section - all the details
More
- Issues and bugs can be raised on the Issue tracker on GitHub
- For discussion or questions please use the dedicated Google Groups forum or our Discord
- See who else is using Catch2