3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2024-11-22 13:26:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Reorganised the readme/ ref docs TOC and added link to reporters docs

Browse Source
This commit is contained in:
Phil Nash 2017-03-15 09:08:20 +00:00
parent 90d89377ea
commit e7984e3711
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/Readme.md
View File

@ -1,23 +1,29 @@
These are the currently documented areas of the framework. There is more to come. To get the most out of Catch, start with the [tutorial](tutorial.md).
Once you're up and running consider the following reference material.
Before looking at this material be sure to read the [tutorial](tutorial.md)
Writing tests:
* [Assertion macros](assertions.md) * [Assertion macros](assertions.md)
* [Matchers](matchers.md) * [Matchers](matchers.md)
* [Logging macros](logging.md) * [Logging macros](logging.md)
* [Test cases and sections](test-cases-and-sections.md) * [Test cases and sections](test-cases-and-sections.md)
* [Test fixtures](test-fixtures.md) * [Test fixtures](test-fixtures.md)
* [Supplying your own main()](own-main.md) * [Reporters](reporters.md)
* [Event Listeners](event-listeners.md) * [Event Listeners](event-listeners.md)
* [Configuration](configuration.md)
Fine tuning:
* [Supplying your own main()](own-main.md)
* [Compile-time configuration](configuration.md)
* [String Conversions](tostring.md) * [String Conversions](tostring.md)
Running:
* [Command line](command-line.md) * [Command line](command-line.md)
* [Build systems](build-systems.md) * [Build systems](build-systems.md)
FAQ:
* [Why are my tests slow to compile?](slow-compiles.md) * [Why are my tests slow to compile?](slow-compiles.md)
* [Known limitations](limitations.md) * [Known limitations](limitations.md)
Other Other:
* [Why Catch?](why-catch.md) * [Why Catch?](why-catch.md)
* [Open Source Projects using Catch](opensource-users.md) * [Open Source Projects using Catch](opensource-users.md)
* [Contributing](contributing.md) * [Contributing](contributing.md)