Progmasoft Git

catch3

Progmasoft Catch3: an independently maintained C++17 test framework with a parallel runner, property checks, snapshots and structured results.

Clonegit clone https://git.progmasoft.com/catch3

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

Commit
e7984e3711bd34b366ff20ca7abc9c9dbf273757
Author
Phil Nash ·
Parents
90d89377ea92

Files · Download .tar.gz

Changes

 docs/Readme.md | 20 +++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)

diff --git a/docs/Readme.md b/docs/Readme.md
index 85c17b61..e7e69080 100644
--- a/docs/Readme.md
+++ b/docs/Readme.md
@@ -1,23 +1,29 @@
-These are the currently documented areas of the framework. There is more to come.
-
-Before looking at this material be sure to read the [tutorial](tutorial.md)
+To get the most out of Catch, start with the [tutorial](tutorial.md).
+Once you're up and running consider the following reference material.
 
+Writing tests:
 * [Assertion macros](assertions.md)
 * [Matchers](matchers.md)
 * [Logging macros](logging.md)
 * [Test cases and sections](test-cases-and-sections.md)
 * [Test fixtures](test-fixtures.md)
-* [Supplying your own main()](own-main.md)
+* [Reporters](reporters.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)
+
+Running:
 * [Command line](command-line.md)
 * [Build systems](build-systems.md)
+
+FAQ:
 * [Why are my tests slow to compile?](slow-compiles.md)
 * [Known limitations](limitations.md)
  
-Other
-
+Other:
 * [Why Catch?](why-catch.md)
 * [Open Source Projects using Catch](opensource-users.md)
 * [Contributing](contributing.md)