aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/catch2/docs/Readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/catch2/docs/Readme.md')
-rw-r--r--contrib/catch2/docs/Readme.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/contrib/catch2/docs/Readme.md b/contrib/catch2/docs/Readme.md
new file mode 100644
index 0000000..d84b4bf
--- /dev/null
+++ b/contrib/catch2/docs/Readme.md
@@ -0,0 +1,43 @@
+<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)
+* [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)