catch2/README.md

27 lines
1.3 KiB
Markdown
Raw Normal View History

2013-06-03 21:03:39 +02:00
![catch logo](catch-logo-small.png)
2013-03-21 20:21:41 +01:00
2015-11-03 18:06:54 +01:00
*v1.2.1-develop.16*
2013-10-21 21:55:01 +02:00
Build status (on Travis CI) [![Build Status](https://travis-ci.org/philsquared/Catch.png)](https://travis-ci.org/philsquared/Catch)
2013-08-05 14:50:14 +02:00
2014-04-16 09:18:06 +02:00
[Please see this page if you are updating from a version before 1.0](docs/whats-changed.md)
2013-06-25 14:21:41 +02: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 20:07:48 +01:00
2013-06-03 21:03:39 +02:00
## What's the Catch?
2013-01-28 08:57:27 +01:00
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:
2013-06-07 22:31:28 +02:00
* [Why do we need yet another C++ Test Framework?](docs/why-catch.md)
2013-06-03 21:03:39 +02:00
* [Tutorial](docs/tutorial.md) - getting started
2014-08-19 09:25:25 +02:00
* [Reference section](docs/Readme.md) - all the details
2013-06-03 21:03:39 +02:00
The documentation will continue until morale improves
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)