Catch/README.md

23 lines
1.1 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
2016-11-29 07:15:50 -05:00
*v1.5.9*
Build status (on Travis CI) [![Build Status](https://travis-ci.org/philsquared/Catch.svg?branch=master)](https://travis-ci.org/philsquared/Catch)
2013-08-05 08:50:14 -04:00
<a href="https://raw.githubusercontent.com/philsquared/Catch/master/single_include/catch.hpp">The latest, single header, version can be downloaded directly using this link</a>
2014-12-09 14:07:48 -05:00
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
2014-08-19 03:25:25 -04:00
* [Reference section](docs/Readme.md) - all the details
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)