2017-08-24 15:21:36 +02:00
< a id = "top" > < / a >
2019-12-06 11:36:12 +01:00
![catch logo ](data/artwork/catch2-logo-small.png )
2013-03-21 20:21:41 +01:00
2017-11-07 19:50:55 +01:00
[![Github Releases ](https://img.shields.io/github/release/catchorg/catch2.svg )](https://github.com/catchorg/catch2/releases)
2017-12-08 21:47:42 +01:00
[![Build Status ](https://travis-ci.org/catchorg/Catch2.svg?branch=master )](https://travis-ci.org/catchorg/Catch2)
2017-12-08 21:35:47 +01:00
[![Build status ](https://ci.appveyor.com/api/projects/status/github/catchorg/Catch2?svg=true )](https://ci.appveyor.com/project/catchorg/catch2)
2017-12-11 13:06:01 +01:00
[![codecov ](https://codecov.io/gh/catchorg/Catch2/branch/master/graph/badge.svg )](https://codecov.io/gh/catchorg/Catch2)
2020-05-03 09:54:18 +02:00
<!-- We can eventually bring this back, but the upload script will have to be more complex -->
<!-- [![Try online ](https://img.shields.io/badge/try-online-blue.svg )](https://wandbox.org/permlink/LzYWgcPrcy9yQmed) -->
2018-07-01 20:48:21 +02:00
[![Join the chat in Discord: https://discord.gg/4CWS9zD ](https://img.shields.io/badge/Discord-Chat!-brightgreen.svg )](https://discord.gg/4CWS9zD)
2013-08-05 14:50:14 +02:00
2017-11-03 14:18:26 +01:00
## Catch2 is released!
2018-01-10 13:53:04 +01:00
If you've been using an earlier version of Catch, please see the
2017-11-03 14:31:59 +01:00
Breaking Changes section of [the release notes ](https://github.com/catchorg/Catch2/releases/tag/v2.0.1 )
2019-03-08 09:56:00 +01:00
before moving to Catch2. You might also like to read [this blog post ](https://levelofindirection.com/blog/catch2-released.html ) for more details.
2017-11-03 14:18:26 +01:00
2013-06-03 21:03:39 +02:00
## What's the Catch?
2013-01-28 08:57:27 +01:00
2020-04-24 20:42:52 +02:00
Catch2 is a multi-paradigm test framework for C++.
2013-06-03 21:03:39 +02:00
## How to use it
This documentation comprises these three parts:
2017-08-24 15:33:38 +02:00
* [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
2017-11-03 14:05:09 +01:00
* Issues and bugs can be raised on the [Issue tracker on GitHub ](https://github.com/catchorg/Catch2/issues )
2018-07-01 20:48:21 +02:00
* For discussion or questions please use [the dedicated Google Groups forum ](https://groups.google.com/forum/?fromgroups#!forum/catch-forum ) or our [Discord ](https://discord.gg/4CWS9zD )
2017-11-03 14:05:09 +01:00
* See [who else is using Catch2 ](docs/opensource-users.md#top )