catch2/README.md

![catch logo](catch-logo-small.png)

*v0.9 build 39 (integration branch)*

# New release with significant changes

[Please see this page for details - including some breaking changes](docs/whats-changed.md)

## 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/reference-index.md) - all the details

## What state is Catch in - can I use it now?

For now Catch is still classed as "in developer preview". However it has already been widely used for over two years. It has proven fairly stable and is in use in some demanding projects. Think of it in the same way that Google uses the term "beta".
At time of writing I'm working towards locking down the public facing interfaces so I can finally give it a 1.0 designation.


## 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)
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
Fixed script for new readme - updated README with new version - fixed casing error for -e opt description 2013-06-07 22:15:25 +02:00			`v0.9 build 39 (integration branch)`
Updated the readme specifically for the Integration branch 2012-10-28 13:15:34 +01:00
Added "what's changed" 2013-06-25 14:21:41 +02:00			`# New release with significant changes`

			`[Please see this page for details - including some breaking changes](docs/whats-changed.md)`

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`
			`* [Reference section](docs/reference-index.md) - all the details`

			`## What state is Catch in - can I use it now?`

			`For now Catch is still classed as "in developer preview". However it has already been widely used for over two years. It has proven fairly stable and is in use in some demanding projects. Think of it in the same way that Google uses the term "beta".`
			`At time of writing I'm working towards locking down the public facing interfaces so I can finally give it a 1.0 designation.`


			`## 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)`