Catch2/docs

Reference

To get the most out of Catch2, start with the tutorial. Once you're up and running consider the following reference material.

Writing tests:

• Assertion macros
• Matchers (asserting complex properties)
• Comparing floating point numbers
• Logging macros
• Test cases and sections
• Test fixtures
• Explicitly skipping, passing, and failing tests at runtime
• Reporters (output customization)
• Event Listeners
• Data Generators (value parameterized tests)
• Other macros
• Micro benchmarking

Fine tuning:

• Supplying your own main()
• Compile-time configuration
• String Conversions

Running:

• Command line reference
• Running specific section/generator

Odds and ends:

• Frequently Asked Questions (FAQ)
• Best practices and other tips
• CMake integration
• Tooling integration (CI, test runners, other)
• Known limitations
• Thread safety in Catch2

Other:

• Why Catch2?
• Migrating from v2 to v3
• Open Source Projects using Catch2
• Commercial Projects using Catch2
• Contributing
• Release Notes
• Deprecations and incoming changes