README.md 2.02 KB
Newer Older
Martin Moene's avatar
Martin Moene committed
1
<a id="top"></a>
Phil Nash's avatar
Phil Nash committed
2
![catch logo](artwork/catch2-logo-small.png)
Phil Nash's avatar
Phil Nash committed
3

Phil Nash's avatar
Phil Nash committed
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)
Martin Hořeňovský's avatar
Martin Hořeňovský committed
7
[![codecov](https://codecov.io/gh/catchorg/Catch2/branch/master/graph/badge.svg)](https://codecov.io/gh/catchorg/Catch2)
Martin Hořeňovský's avatar
v2.2.1  
Martin Hořeňovský committed
8
[![Try online](https://img.shields.io/badge/try-online-blue.svg)](https://wandbox.org/permlink/zDKMK3eGMC9IP2jy)
Kosta's avatar
Kosta committed
9

Martin Hořeňovský's avatar
v2.2.1  
Martin Hořeňovský committed
10
<a href="https://github.com/catchorg/Catch2/releases/download/v2.2.1/catch.hpp">The latest version of the single header can be downloaded directly using this link</a>
11

Phil Nash's avatar
Phil Nash committed
12 13
## Catch2 is released!

Martin Hořeňovský's avatar
v2.1.0  
Martin Hořeňovský committed
14
If you've been using an earlier version of Catch, please see the
15
Breaking Changes section of [the release notes](https://github.com/catchorg/Catch2/releases/tag/v2.0.1)
Phil Nash's avatar
Phil Nash committed
16
before moving to Catch2. You might also like to read [this blog post](http://www.levelofindirection.com/journal/2017/11/3/catch2-released.html) for more details.
Phil Nash's avatar
Phil Nash committed
17

Phil Nash's avatar
Phil Nash committed
18
## What's the Catch?
Phil Nash's avatar
Phil Nash committed
19

20
Catch2 stands for C++ Automated Test Cases in a Header and is a
Phil Nash's avatar
Phil Nash committed
21
multi-paradigm test framework for C++. which also supports Objective-C
22
(and maybe C).
Phil Nash's avatar
Phil Nash committed
23 24
It is primarily distributed as a single header file, although certain
extensions may require additional headers.
Phil Nash's avatar
Phil Nash committed
25 26 27 28

## How to use it
This documentation comprises these three parts:

29 30 31
* [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
Phil Nash's avatar
Phil Nash committed
32 33

## More
34
* Issues and bugs can be raised on the [Issue tracker on GitHub](https://github.com/catchorg/Catch2/issues)
Phil Nash's avatar
Phil Nash committed
35
* For discussion or questions please use [the dedicated Google Groups forum](https://groups.google.com/forum/?fromgroups#!forum/catch-forum)
36
* See [who else is using Catch2](docs/opensource-users.md#top)