Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / catch2 / refs/heads/int/13/fp4 / . / README.md
blob: 3167d24d1f1443a56fd84e28db74071f16e434d8 [file] [log] [blame] [view]
Martin Moenee8225052017-08-24 15:21:36 +0200[diff] [blame]1<a id="top"></a>
Phil Nash3a4c7652017-11-07 11:25:03 +0000[diff] [blame]2![catch logo](artwork/catch2-logo-small.png)
Phil Nash22b79212013-03-21 19:21:41 +0000[diff] [blame]3
Phil Nash07ac9b92017-11-07 18:50:55 +0000[diff] [blame]4[![Github Releases](https://img.shields.io/github/release/catchorg/catch2.svg)](https://github.com/catchorg/catch2/releases)
Martin Hořeňovský0cf05d52017-12-08 21:47:42 +0100[diff] [blame]5[![Build Status](https://travis-ci.org/catchorg/Catch2.svg?branch=master)](https://travis-ci.org/catchorg/Catch2)
Martin Hořeňovský11887fb2017-12-08 21:35:47 +0100[diff] [blame]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ý39798452017-12-11 13:06:01 +0100[diff] [blame]7[![codecov](https://codecov.io/gh/catchorg/Catch2/branch/master/graph/badge.svg)](https://codecov.io/gh/catchorg/Catch2)
Martin Hořeňovský5f94c8d2020-03-19 12:37:51 +0100[diff] [blame]8[![Try online](https://img.shields.io/badge/try-online-blue.svg)](https://wandbox.org/permlink/ZI5SYb7JE1UJhAKP)
Martin Hořeňovskýe69c7ce2018-07-01 20:48:21 +0200[diff] [blame]9[![Join the chat in Discord: https://discord.gg/4CWS9zD](https://img.shields.io/badge/Discord-Chat!-brightgreen.svg)](https://discord.gg/4CWS9zD)
10
Kosta7fcde922013-08-05 14:50:14 +0200[diff] [blame]11
Martin Hořeňovský5f94c8d2020-03-19 12:37:51 +0100[diff] [blame]12<a href="https://github.com/catchorg/Catch2/releases/download/v2.11.2/catch.hpp">The latest version of the single header can be downloaded directly using this link</a>
Phil Nashd8e3c1f2014-12-09 19:07:48 +0000[diff] [blame]13
Phil Nashcf76a792017-11-03 13:18:26 +0000[diff] [blame]14## Catch2 is released!
15
Martin Hořeňovskýcd76f572018-01-10 13:53:04 +0100[diff] [blame]16If you've been using an earlier version of Catch, please see the
Phil Nash53f6d3f2017-11-03 13:31:59 +0000[diff] [blame]17Breaking Changes section of [the release notes](https://github.com/catchorg/Catch2/releases/tag/v2.0.1)
Clare Macrae0424c9a2019-03-08 08:56:00 +0000[diff] [blame]18before moving to Catch2. You might also like to read [this blog post](https://levelofindirection.com/blog/catch2-released.html) for more details.
Phil Nashcf76a792017-11-03 13:18:26 +0000[diff] [blame]19
Phil Nash130ec982013-06-03 20:03:39 +0100[diff] [blame]20## What's the Catch?
Phil Nash2f92db92012-10-28 12:15:34 +0000[diff] [blame]21
Martin Hořeňovský820271b2019-07-02 20:43:37 +0200[diff] [blame]22Catch2 is a multi-paradigm test framework for C++. which also supports
23Objective-C (and maybe C).
Phil Nash0b52dbe2017-08-17 08:28:45 +0100[diff] [blame]24It is primarily distributed as a single header file, although certain
25extensions may require additional headers.
Phil Nash130ec982013-06-03 20:03:39 +0100[diff] [blame]26
27## How to use it
28This documentation comprises these three parts:
29
Martin Moene6c09b452017-08-24 15:33:38 +0200[diff] [blame]30* [Why do we need yet another C++ Test Framework?](docs/why-catch.md#top)
31* [Tutorial](docs/tutorial.md#top) - getting started
32* [Reference section](docs/Readme.md#top) - all the details
Phil Nash130ec982013-06-03 20:03:39 +0100[diff] [blame]33
Phil Nash130ec982013-06-03 20:03:39 +0100[diff] [blame]34## More
Phil Nash7423a482017-11-03 13:05:09 +0000[diff] [blame]35* Issues and bugs can be raised on the [Issue tracker on GitHub](https://github.com/catchorg/Catch2/issues)
Martin Hořeňovskýe69c7ce2018-07-01 20:48:21 +0200[diff] [blame]36* 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)
Phil Nash7423a482017-11-03 13:05:09 +0000[diff] [blame]37* See [who else is using Catch2](docs/opensource-users.md#top)