catch2/README.md

35 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2017-08-24 15:21:36 +02:00
<a id="top"></a>
2013-06-03 21:03:39 +02:00
![catch logo](catch-logo-small.png)
2013-03-21 20:21:41 +01:00
[![Github Releases](https://img.shields.io/github/release/philsquared/catch.svg)](https://github.com/catchorg/catch2/releases)
2017-11-03 14:15:22 +01:00
[![Build Status](https://travis-ci.org/philsquared/Catch.svg)](https://travis-ci.org/philsquared/Catch)
[![Build status](https://ci.appveyor.com/api/projects/status/hrtk60hv6tw6fght)](https://ci.appveyor.com/project/philsquared/catch)
2013-08-05 14:50:14 +02:00
2017-11-03 14:15:22 +01:00
<a href="https://github.com/catchorg/Catch2/releases/download/v2.0.1/catch.hpp">The latest version of the single header can be downloaded directly using this link</a>
2014-12-09 20:07:48 +01:00
2017-11-03 14:18:26 +01:00
## Catch2 is released!
If you've been using an earlier version of Catch, please see the
Breaking Changes section of [the release notes](https://github.com/catchorg/Catch2/releases/tag/v2.0.1)
2017-11-03 14:18:26 +01:00
before moving to Catch2.
2013-06-03 21:03:39 +02:00
## What's the Catch?
2013-01-28 08:57:27 +01:00
Catch2 stands for C++ Automated Test Cases in a Header and is a
2017-08-17 09:28:45 +02:00
multi-paradigm test framework for C++. which also supports Objective-C
(and maybe C).
2017-08-17 09:28:45 +02:00
It is primarily distributed as a single header file, although certain
extensions may require additional headers.
2013-06-03 21:03:39 +02:00
## How to use it
This documentation comprises these three parts:
* [Why do we need yet another C++ Test Framework?](docs/why-catch.md#top)
* [Tutorial](docs/tutorial.md#top) - getting started
* [Reference section](docs/Readme.md#top) - all the details
2013-06-03 21:03:39 +02:00
## More
* Issues and bugs can be raised on the [Issue tracker on GitHub](https://github.com/catchorg/Catch2/issues)
2013-06-03 21:03:39 +02:00
* 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 Catch2](docs/opensource-users.md#top)