Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/docs/tutorial.md
diff options
context:
space:
mode:
authorLeitwolf2026-10-25 10:31:36 +0300
committerGitHub2026-10-25 10:31:36 +0300
commitd2e3e074bb2e1b8ffd9fc990d0b87667ea602f58 (patch)
tree0bce4462b2e190c39b3e1c5f697e3e4abd1a5e2a /docs/tutorial.md
parent13f81a480a93807c14dddb5abdb97355ced4d4c5 (diff)
parent126dc333564cb72b5115d9a9242d66694694b6d0 (diff)
downloadcatch3-d2e3e074bb2e1b8ffd9fc990d0b87667ea602f58.tar.gz
Merge pull request #18 from Progmasoft/build/catch3-identity
Give Catch3 its own build names and headers
Diffstat (limited to 'docs/tutorial.md')
-rw-r--r--docs/tutorial.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/tutorial.md b/docs/tutorial.md
index fb316c10..cf895705 100644
--- a/docs/tutorial.md
+++ b/docs/tutorial.md
@@ -1,6 +1,6 @@
<a id="top"></a>
-> **Catch3 compatibility reference:** This page describes the bundled Catch2-compatible API. Names such as `Catch2`, `catch2/`, and `Catch2::Catch2WithMain` remain where they are actual compatibility interfaces. See [Catch3 additions](progmasoft-catch3.md) for Progmasoft APIs.
+> **Catch3 compatibility reference:** This page describes the test-writing API Catch3 shares with Catch2: the macros, such as `TEST_CASE` and `REQUIRE`, and the `Catch::` namespace keep Catch2's names. Headers and build names are Catch3's own (`<Progmasoft/Catch3/TestMacros.hpp>`, `find_package(Catch3)`, `Catch3::Catch3WithMain`). See [Catch3 additions](progmasoft-catch3.md) for Progmasoft APIs.
# Tutorial
@@ -17,8 +17,9 @@
Clone or consume [Progmasoft/catch3](https://github.com/Progmasoft/catch3),
then use its [CMake integration](cmake-integration.md#top) or another supported
-build system. The examples in this tutorial exercise the bundled
-Catch2-compatible API, so their actual include paths remain `catch2/...`.
+build system. The examples in this tutorial use the Catch2-compatible API:
+its macros and the `Catch::` namespace, from headers such as
+`<Progmasoft/Catch3/TestMacros.hpp>`.
For property tests, snapshots, and the result/XML writer, continue with the
[Progmasoft extensions](progmasoft-catch3.md).
@@ -34,7 +35,7 @@ unsigned int Factorial( unsigned int number ) {
```
```c++
-#include <catch2/catch_test_macros.hpp>
+#include <Progmasoft/Catch3/TestMacros.hpp>
unsigned int Factorial( unsigned int number ) {
return number <= 1 ? number : Factorial(number-1)*number;