From 0b52dbe8bbdc7289d1f025a4906ea4107c1e0446 Mon Sep 17 00:00:00 2001 From: Phil Nash Date: Thu, 17 Aug 2017 08:28:45 +0100 Subject: [PATCH] Small doc updates --- README.md | 12 ++++++++---- docs/why-catch.md | 17 ++++++++--------- 2 files changed, 16 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 372e2279..b46c6825 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,18 @@ ![catch logo](catch-logo-small.png) [![Github Releases](https://img.shields.io/github/release/philsquared/catch.svg)](https://github.com/philsquared/catch/releases) -[![Build Status](https://travis-ci.org/philsquared/Catch.svg?branch=master)](https://travis-ci.org/philsquared/Catch) -[![Build status](https://ci.appveyor.com/api/projects/status/hrtk60hv6tw6fght/branch/master?svg=true)](https://ci.appveyor.com/project/philsquared/catch/branch/master) +[![Build Status](https://travis-ci.org/philsquared/Catch.svg?branch=catch2)](https://travis-ci.org/philsquared/Catch?branch=catch2) +[![Build status](https://ci.appveyor.com/api/projects/status/hrtk60hv6tw6fght/branch/catch2?svg=true)](https://ci.appveyor.com/project/philsquared/catch/branch/catch2) -The latest, single header, version can be downloaded directly using this link +The latest version of the single header can be downloaded directly using this link ## What's the Catch? -Catch stands for C++ Automated Test Cases in Headers and is a multi-paradigm automated test framework for C++ and Objective-C (and, maybe, C). It is implemented entirely in a set of header files, but is packaged up as a single header for extra convenience. +Catch stands for C++ Automated Test Cases in Headers and is a +multi-paradigm test framework for C++. which also supports Objective-C +and, maybe, C. +It is primarily distributed as a single header file, although certain +extensions may require additional headers. ## How to use it This documentation comprises these three parts: diff --git a/docs/why-catch.md b/docs/why-catch.md index 1dbc43bc..82257d68 100644 --- a/docs/why-catch.md +++ b/docs/why-catch.md @@ -1,12 +1,18 @@ # 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. +Good question. For C++ there are quite a number of established frameworks, +including (but not limited to), +[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), +[CppUnit](http://sourceforge.net/apps/mediawiki/cppunit/index.php?title=Main_Page), +[Cute](http://r2.ifs.hsr.ch/cute), +[many, many more](http://en.wikipedia.org/wiki/List_of_unit_testing_frameworks#C.2B.2B). So what does Catch bring to the party that differentiates it from these? Apart from a Catchy name, of course. ## Key Features -* Really easy to get started. Just download catch.hpp, `#include` it and you're away. +* Quick and Really easy to get started. Just download catch.hpp, `#include` it and you're away. * No external dependencies. As long as you can compile C++11 and have a C++ standard library available. * Write test cases as, self-registering, functions (or methods, if you prefer). * Divide test cases into sections, each of which is run in isolation (eliminates the need for fixtures). @@ -28,13 +34,6 @@ So what does Catch bring to the party that differentiates it from these? Apart f * Internal and friendly macros are isolated so name clashes can be managed * Matchers -## Objective-C-specific features - -* Automatically detects if you are using it from an Objective-C project -* Works with and without ARC with no additional configuration -* Implement test fixtures using Obj-C classes too (like OCUnit) -* Additional built in matchers that work with Obj-C types (e.g. string matchers) - ## Who else is using Catch? See the list of [open source projects using Catch](opensource-users.md).