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

Doc updates

Commit
0ec7ea2e4934fa5f040201ca8634bd390fa40dbe
Author
Phil Nash ·
Parents
7d5f2715ce9e

Files · Download .tar.gz

Changes

 README.md         | 2 +-
 docs/own-main.md  | 2 ++
 docs/tutorial.md  | 4 ++--
 docs/why-catch.md | 4 +++-
 4 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index e39be2c9..dadfd7d6 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ Catch stands for C++ Automated Test Cases in Headers and is a multi-paradigm aut
 ## How to use it
 This documentation comprises these three parts:
 
-* [Why do we need yet another C++ Unit Test System?](docs/why-catch.md)
+* [Why do we need yet another C++ Test Framework?](docs/why-catch.md)
 * [Tutorial](docs/tutorial.md) - getting started
 * [Reference section](docs/reference-index.md) - all the details
 
diff --git a/docs/own-main.md b/docs/own-main.md
index 473bc566..2508fc4e 100644
--- a/docs/own-main.md
+++ b/docs/own-main.md
@@ -1,5 +1,7 @@
 placeholder for using your own main
 
+(note that this has changed significantly with recent check-ins on Integration. I hope to have this page updated very soon with more details)
+
 ---
 
 [Home](../README.md)
\ No newline at end of file
diff --git a/docs/tutorial.md b/docs/tutorial.md
index 5d4df5a3..b418c61b 100644
--- a/docs/tutorial.md
+++ b/docs/tutorial.md
@@ -1,8 +1,8 @@
 # Getting Catch
 
-The simplest way to get Catch is to download the single header version from [builds.catch-lib.net](builds.catch-lib.net). Don't be put off by the word "builds" there. The single header is generated by merging a set of individual headers but it is still just normal source code in a header file.
+The simplest way to get Catch is to download the single header version from [http://builds.catch-lib.net](builds.catch-lib.net). Don't be put off by the word "builds" there. The single header is generated by merging a set of individual headers but it is still just normal source code in a header file.
 
-The full source for Catch, including test projects, documentation, and other things, is hosted on GitHub. [catch-lib.net](catch-lib.net) will redirect you there.
+The full source for Catch, including test projects, documentation, and other things, is hosted on GitHub. [http://catch-lib.net](catch-lib.net) will redirect you there.
 
 
 ## Where to put it?
diff --git a/docs/why-catch.md b/docs/why-catch.md
index 4a686b1b..2b08edc5 100644
--- a/docs/why-catch.md
+++ b/docs/why-catch.md
@@ -1,3 +1,5 @@
+# Why do we need yet another C++ test framework?
+
 Good question. For C++ there are quite a number of established frameworks, including (but not limited to), [CppUnit](http://sourceforge.net/apps/mediawiki/cppunit/index.php?title=Main_Page), [Google Test](http://code.google.com/p/googletest/), [Boost.Test](http://www.boost.org/doc/libs/1_49_0/libs/test/doc/html/index.html), [Aeryn](https://launchpad.net/aeryn), [Cute](http://r2.ifs.hsr.ch/cute), [Fructose](http://fructose.sourceforge.net/) and [many, many more](http://en.wikipedia.org/wiki/List_of_unit_testing_frameworks#C.2B.2B). Even for Objective-C there are a few, including OCUnit - which now comes bundled with XCode.
 
 So what does Catch bring to the party that differentiates it from these? Apart from a Catchy name, of course.
@@ -9,7 +11,7 @@ So what does Catch bring to the party that differentiates it from these? Apart f
 * Write test cases as, self-registering, functions or methods.
 * Divide test cases into sections, each of which is run in isolation (eliminates the need for fixtures!)
 * Use BDD-style GIVEN-WHEN-THEN in place of test cases and sections.
-* Only one core assertion macro for comparisons. Standard C/c++ operators are used for the comparison - yet the full expression is decomposed and lhs and rhs values are logged.
+* Only one core assertion macro for comparisons. Standard C/C++ operators are used for the comparison - yet the full expression is decomposed and lhs and rhs values are logged.
 
 ## Other core features