Readme.md
1 <a id="top"></a> 2 # Reference 3 4 To get the most out of Catch2, start with the [tutorial](tutorial.md#top). 5 Once you're up and running consider the following reference material. 6 7 **Writing tests:** 8 * [Assertion macros](assertions.md#top) 9 * [Matchers (asserting complex properties)](matchers.md#top) 10 * [Comparing floating point numbers](comparing-floating-point-numbers.md#top) 11 * [Logging macros](logging.md#top) 12 * [Test cases and sections](test-cases-and-sections.md#top) 13 * [Test fixtures](test-fixtures.md#top) 14 * [Explicitly skipping, passing, and failing tests at runtime](skipping-passing-failing.md#top) 15 * [Reporters (output customization)](reporters.md#top) 16 * [Event Listeners](event-listeners.md#top) 17 * [Data Generators (value parameterized tests)](generators.md#top) 18 * [Other macros](other-macros.md#top) 19 * [Micro benchmarking](benchmarks.md#top) 20 21 **Fine tuning:** 22 * [Supplying your own main()](own-main.md#top) 23 * [Compile-time configuration](configuration.md#top) 24 * [String Conversions](tostring.md#top) 25 26 **Running:** 27 * [Command line](command-line.md#top) 28 29 **Odds and ends:** 30 * [Frequently Asked Questions (FAQ)](faq.md#top) 31 * [Best practices and other tips](usage-tips.md#top) 32 * [CMake integration](cmake-integration.md#top) 33 * [Tooling integration (CI, test runners, other)](ci-and-misc.md#top) 34 * [Known limitations](limitations.md#top) 35 36 **Other:** 37 * [Why Catch2?](why-catch.md#top) 38 * [Migrating from v2 to v3](migrate-v2-to-v3.md#top) 39 * [Open Source Projects using Catch2](opensource-users.md#top) 40 * [Commercial Projects using Catch2](commercial-users.md#top) 41 * [Contributing](contributing.md#top) 42 * [Release Notes](release-notes.md#top) 43 * [Deprecations and incoming changes](deprecations.md#top)