From bc524d70253a4ab2fe40c3ca3e5666e267c0a4d1 Mon Sep 17 00:00:00 2001 From: Lexi Winter Date: Sun, 29 Jun 2025 19:25:29 +0100 Subject: import catch2 3.8.1 --- docs/Readme.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/Readme.md (limited to 'docs/Readme.md') diff --git a/docs/Readme.md b/docs/Readme.md new file mode 100644 index 0000000..d84b4bf --- /dev/null +++ b/docs/Readme.md @@ -0,0 +1,43 @@ + +# Reference + +To get the most out of Catch2, start with the [tutorial](tutorial.md#top). +Once you're up and running consider the following reference material. + +**Writing tests:** +* [Assertion macros](assertions.md#top) +* [Matchers (asserting complex properties)](matchers.md#top) +* [Comparing floating point numbers](comparing-floating-point-numbers.md#top) +* [Logging macros](logging.md#top) +* [Test cases and sections](test-cases-and-sections.md#top) +* [Test fixtures](test-fixtures.md#top) +* [Explicitly skipping, passing, and failing tests at runtime](skipping-passing-failing.md#top) +* [Reporters (output customization)](reporters.md#top) +* [Event Listeners](event-listeners.md#top) +* [Data Generators (value parameterized tests)](generators.md#top) +* [Other macros](other-macros.md#top) +* [Micro benchmarking](benchmarks.md#top) + +**Fine tuning:** +* [Supplying your own main()](own-main.md#top) +* [Compile-time configuration](configuration.md#top) +* [String Conversions](tostring.md#top) + +**Running:** +* [Command line](command-line.md#top) + +**Odds and ends:** +* [Frequently Asked Questions (FAQ)](faq.md#top) +* [Best practices and other tips](usage-tips.md#top) +* [CMake integration](cmake-integration.md#top) +* [Tooling integration (CI, test runners, other)](ci-and-misc.md#top) +* [Known limitations](limitations.md#top) + +**Other:** +* [Why Catch2?](why-catch.md#top) +* [Migrating from v2 to v3](migrate-v2-to-v3.md#top) +* [Open Source Projects using Catch2](opensource-users.md#top) +* [Commercial Projects using Catch2](commercial-users.md#top) +* [Contributing](contributing.md#top) +* [Release Notes](release-notes.md#top) +* [Deprecations and incoming changes](deprecations.md#top) -- cgit v1.2.3