catch2/README.md

![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)

<a href="https://github.com/philsquared/Catch/releases/download/v1.9.5/catch.hpp">The latest, single header, version can be downloaded directly using this link</a>

## 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.

## How to use it
This documentation comprises these three parts:

* [Why do we need yet another C++ Test Framework?](docs/why-catch.md)
* [Tutorial](docs/tutorial.md) - getting started
* [Reference section](docs/Readme.md) - all the details

## More
* Issues and bugs can be raised on the [Issue tracker on GitHub](https://github.com/philsquared/Catch/issues)
* For discussion or questions please use [the dedicated Google Groups forum](https://groups.google.com/forum/?fromgroups#!forum/catch-forum)
* See [who else is using Catch](docs/opensource-users.md)
Start of new docs 2013-06-03 21:03:39 +02:00			`![catch logo](catch-logo-small.png)`
Try as not first line 2013-03-21 20:21:41 +01:00
Added release badge 2017-03-03 16:25:58 +01:00			`[![Github Releases](https://img.shields.io/github/release/philsquared/catch.svg)](https://github.com/philsquared/catch/releases)`
Add AppVeyor status 2017-03-03 15:38:20 +01:00			`[![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)`
added travis status to the readme 2013-08-05 14:50:14 +02:00
v1.9.5 2017-06-15 13:08:26 +02:00			`<a href="https://github.com/philsquared/Catch/releases/download/v1.9.5/catch.hpp">The latest, single header, version can be downloaded directly using this link</a>`
Last tweak to download text - honest 2014-12-09 20:07:48 +01:00
Start of new docs 2013-06-03 21:03:39 +02:00			`## What's the Catch?`
Added google group to README 2013-01-28 08:57:27 +01:00
Start of new docs 2013-06-03 21:03:39 +02:00			`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.`

			`## How to use it`
			`This documentation comprises these three parts:`

Doc updates 2013-06-07 22:31:28 +02:00			`* [Why do we need yet another C++ Test Framework?](docs/why-catch.md)`
Start of new docs 2013-06-03 21:03:39 +02:00			`* [Tutorial](docs/tutorial.md) - getting started`
Fixed link to reference section 2014-08-19 09:25:25 +02:00			`* [Reference section](docs/Readme.md) - all the details`
Start of new docs 2013-06-03 21:03:39 +02:00
			`## More`
			`* Issues and bugs can be raised on the [Issue tracker on GitHub](https://github.com/philsquared/Catch/issues)`
			`* For discussion or questions please use [the dedicated Google Groups forum](https://groups.google.com/forum/?fromgroups#!forum/catch-forum)`
Added links to open source users page from general pages 2017-02-10 23:50:40 +01:00			`* See [who else is using Catch](docs/opensource-users.md)`