Catch/README.md

29 lines
1.7 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
2017-03-03 10:25:58 -05:00
[![Github Releases](https://img.shields.io/github/release/philsquared/catch.svg)](https://github.com/philsquared/catch/releases)
2017-03-03 09:38:20 -05:00
[![Build Status](https://travis-ci.org/philsquared/Catch.svg?branch=master)](https://travis-ci.org/philsquared/Catch)
[![Build status](https://ci.appveyor.com/api/projects/status/hrtk60hv6tw6fght/branch/master?svg=true)](https://ci.appveyor.com/project/philsquared/catch/branch/master)
2018-03-02 15:22:10 -05:00
[![Try online](https://img.shields.io/badge/try-online-blue.svg)](https://wandbox.org/permlink/q3wLegtaHunTHSls)
2013-08-05 08:50:14 -04:00
2018-03-02 15:22:10 -05:00
<a href="https://github.com/philsquared/Catch/releases/download/v1.12.1/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)
* See [who else is using Catch](docs/opensource-users.md)
2017-07-04 04:10:36 -04:00
## Help us out
2017-07-05 09:54:38 -04:00
We're currently running [a survey](https://www.surveymonkey.co.uk/r/TLLYQJW) to help us shape the future of Catch.
Please take a few moments to fill it out (there's only ten questions).