• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<a id="top"></a>
2![catch logo](artwork/catch2-logo-small.png)
3
4[![Github Releases](https://img.shields.io/github/release/catchorg/catch2.svg)](https://github.com/catchorg/catch2/releases)
5[![Build Status](https://travis-ci.org/catchorg/Catch2.svg?branch=master)](https://travis-ci.org/catchorg/Catch2)
6[![Build status](https://ci.appveyor.com/api/projects/status/github/catchorg/Catch2?svg=true)](https://ci.appveyor.com/project/catchorg/catch2)
7[![codecov](https://codecov.io/gh/catchorg/Catch2/branch/master/graph/badge.svg)](https://codecov.io/gh/catchorg/Catch2)
8[![Try online](https://img.shields.io/badge/try-online-blue.svg)](https://wandbox.org/permlink/rsEsNO9M0flb5NlQ)
9[![Join the chat in Discord: https://discord.gg/4CWS9zD](https://img.shields.io/badge/Discord-Chat!-brightgreen.svg)](https://discord.gg/4CWS9zD)
10
11
12<a href="https://github.com/catchorg/Catch2/releases/download/v2.7.2/catch.hpp">The latest version of the single header can be downloaded directly using this link</a>
13
14## Catch2 is released!
15
16If you've been using an earlier version of Catch, please see the
17Breaking Changes section of [the release notes](https://github.com/catchorg/Catch2/releases/tag/v2.0.1)
18before moving to Catch2. You might also like to read [this blog post](https://levelofindirection.com/blog/catch2-released.html) for more details.
19
20## What's the Catch?
21
22Catch2 stands for C++ Automated Test Cases in a Header and is a
23multi-paradigm test framework for C++. which also supports Objective-C
24(and maybe C).
25It is primarily distributed as a single header file, although certain
26extensions may require additional headers.
27
28## How to use it
29This documentation comprises these three parts:
30
31* [Why do we need yet another C++ Test Framework?](docs/why-catch.md#top)
32* [Tutorial](docs/tutorial.md#top) - getting started
33* [Reference section](docs/Readme.md#top) - all the details
34
35## More
36* Issues and bugs can be raised on the [Issue tracker on GitHub](https://github.com/catchorg/Catch2/issues)
37* 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)
38* See [who else is using Catch2](docs/opensource-users.md#top)
39