catch2/docs/Readme.md

<a id="top"></a>
# 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)
* [Skipping tests at runtime](skipping.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)
Add html anchor 'top' 2017-08-24 15:21:36 +02:00			`<a id="top"></a>`
Add page titles 2017-08-24 22:21:54 +02:00			`# Reference`

Updated some Catch references to Catch2 2017-11-03 14:05:09 +01:00			`To get the most out of Catch2, start with the [tutorial](tutorial.md#top).`
Reorganised the readme/ ref docs TOC and added link to reporters docs 2017-03-15 10:08:20 +01:00			`Once you're up and running consider the following reference material.`
Add Readme as documentation entry 2014-08-15 14:12:53 +02:00
Bold section 'headings' in docs/readme.md 2022-10-15 23:40:35 +02:00			`Writing tests:`
Let toplevel links to .md files link to .md#top 2017-08-24 15:33:38 +02:00			`* [Assertion macros](assertions.md#top)`
Add extra explanations to some items in docs/readme.md This should make it easier for people to find what they need, e.g. finding generators by looking for "value parameterized tests". 2022-10-15 23:41:51 +02:00			`* [Matchers (asserting complex properties)](matchers.md#top)`
Centralize and update docs for floating point comparisons The new docs mention that Approx is deprecated and should not be used, and explain the reasons behind it. Closes #1444 2022-10-14 22:14:52 +02:00			`* [Comparing floating point numbers](comparing-floating-point-numbers.md#top)`
Let toplevel links to .md files link to .md#top 2017-08-24 15:33:38 +02:00			`* [Logging macros](logging.md#top)`
			`* [Test cases and sections](test-cases-and-sections.md#top)`
			`* [Test fixtures](test-fixtures.md#top)`
Add new SKIP macro for skipping tests at runtime (#2360) * Add new SKIP macro for skipping tests at runtime This adds a new `SKIP` macro for dynamically skipping tests at runtime. The "skipped" status of a test case is treated as a first-class citizen, like "succeeded" or "failed", and is reported with a new color on the console. * Don't show "skipped assertions" in console/compact reporters Also extend skip tests to cover a few more use cases. * Return exit code 4 if all test cases are skipped * Use LightGrey for the skip colour This isn't great, but is better than the deep blue that was borderline invisible on dark backgrounds. The fix is to redo the colouring a bit, including introducing light-blue that is actually visible. * Add support for explicit skips in all reporters * --allow-running-no-tests also allows all tests to be skipped * Add docs for SKIP macro, deprecate IEventListener::skipTest Co-authored-by: Martin Hořeňovský <martin.horenovsky@gmail.com> 2023-01-12 15:01:47 +01:00			`* [Skipping tests at runtime](skipping.md#top)`
Add extra explanations to some items in docs/readme.md This should make it easier for people to find what they need, e.g. finding generators by looking for "value parameterized tests". 2022-10-15 23:41:51 +02:00			`* [Reporters (output customization)](reporters.md#top)`
Let toplevel links to .md files link to .md#top 2017-08-24 15:33:38 +02:00			`* [Event Listeners](event-listeners.md#top)`
Add extra explanations to some items in docs/readme.md This should make it easier for people to find what they need, e.g. finding generators by looking for "value parameterized tests". 2022-10-15 23:41:51 +02:00			`* [Data Generators (value parameterized tests)](generators.md#top)`
Add documentation for some miscellaneous and less important macros Fixes #1367 2018-09-17 10:51:44 +02:00			`* [Other macros](other-macros.md#top)`
Link benchmarking docs from the doc main page 2019-06-15 09:23:00 +02:00			`* [Micro benchmarking](benchmarks.md#top)`
Reorganised the readme/ ref docs TOC and added link to reporters docs 2017-03-15 10:08:20 +01:00
Bold section 'headings' in docs/readme.md 2022-10-15 23:40:35 +02:00			`Fine tuning:`
Let toplevel links to .md files link to .md#top 2017-08-24 15:33:38 +02:00			`* [Supplying your own main()](own-main.md#top)`
			`* [Compile-time configuration](configuration.md#top)`
			`* [String Conversions](tostring.md#top)`
Reorganised the readme/ ref docs TOC and added link to reporters docs 2017-03-15 10:08:20 +01:00
Bold section 'headings' in docs/readme.md 2022-10-15 23:40:35 +02:00			`Running:`
Let toplevel links to .md files link to .md#top 2017-08-24 15:33:38 +02:00			`* [Command line](command-line.md#top)`
Update CMake and build documentation 2018-06-21 23:34:17 +02:00
Bold section 'headings' in docs/readme.md 2022-10-15 23:40:35 +02:00			`Odds and ends:`
Add FAQ page to the documentation 2021-11-19 15:23:50 +01:00			`* [Frequently Asked Questions (FAQ)](faq.md#top)`
Add doc page with best practices and other usage tips 2022-06-22 00:13:53 +02:00			`* [Best practices and other tips](usage-tips.md#top)`
Update CMake and build documentation 2018-06-21 23:34:17 +02:00			`* [CMake integration](cmake-integration.md#top)`
Add Bazel support to the documentation 2022-10-21 10:46:56 +02:00			`* [Tooling integration (CI, test runners, other)](ci-and-misc.md#top)`
Let toplevel links to .md files link to .md#top 2017-08-24 15:33:38 +02:00			`* [Known limitations](limitations.md#top)`
Trim superfluous whitespace in docs 2022-10-17 15:02:45 +02:00
Bold section 'headings' in docs/readme.md 2022-10-15 23:40:35 +02:00			`Other:`
Update why-catch.md 2021-08-07 21:56:17 +02:00			`* [Why Catch2?](why-catch.md#top)`
Link to the migration docs from main readme and docs/readme 2020-10-31 09:08:58 +01:00			`* [Migrating from v2 to v3](migrate-v2-to-v3.md#top)`
Update users docs 2021-08-08 17:08:37 +02:00			`* [Open Source Projects using Catch2](opensource-users.md#top)`
			`* [Commercial Projects using Catch2](commercial-users.md#top)`
Let toplevel links to .md files link to .md#top 2017-08-24 15:33:38 +02:00			`* [Contributing](contributing.md#top)`
			`* [Release Notes](release-notes.md#top)`
Turn "deprecations" into "deprecations and planned changes" This captures the intent better, as some changes are indeed plain deprecations leading to removal, but other changes can be viewed as minor tune-ups instead. 2018-11-24 18:01:20 +01:00			`* [Deprecations and incoming changes](deprecations.md#top)`