Catch/README.md

29 lines
1.4 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
*v1.0 build 6 (master branch)*
2013-08-06 05:14:54 -04:00
[![Build Status](http://travis-ci.org/AIM360/Catch.png?branch=master)](http://travis-ci.org/AIM360/Catch) Travis CI build status for the `master` branch of this fork
2013-08-06 05:14:54 -04:00
[![Build Status](http://travis-ci.org/AIM360/Catch.png?branch=Integration)](http://travis-ci.org/AIM360/Catch) Travis CI build status for the `Integration` branch of this fork
2013-08-05 08:50:14 -04:00
2013-06-25 08:21:41 -04:00
# New release with significant changes
[Please see this page for details - including some breaking changes](docs/whats-changed.md)
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:
2013-06-07 16:31:28 -04:00
* [Why do we need yet another C++ Test Framework?](docs/why-catch.md)
2013-06-03 15:03:39 -04:00
* [Tutorial](docs/tutorial.md) - getting started
* [Reference section](docs/reference-index.md) - all the details
The documentation will continue until morale improves
2013-06-03 15:03:39 -04: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)