Catch/README.md

25 lines
1.3 KiB
Markdown
Raw Normal View History

2013-06-03 15:03:39 -04:00
![catch logo](catch-logo-small.png)
2013-03-21 15:21:41 -04:00
2013-06-03 15:03:39 -04:00
*v0.9 build 38 (integration branch)*
2013-06-03 15:03:39 -04:00
## What's the Catch?
2013-01-28 02:57:27 -05:00
2013-06-03 15:03:39 -04: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:
* [Why do we need yet another C++ Unit Test System?](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)