catch2/README.md

<a id="top"></a>
![catch logo](artwork/catch2-logo-small.png)

[![Github Releases](https://img.shields.io/github/release/catchorg/catch2.svg)](https://github.com/catchorg/catch2/releases)
[![Build Status](https://travis-ci.org/catchorg/Catch2.svg?branch=master)](https://travis-ci.org/catchorg/Catch2)
[![Build status](https://ci.appveyor.com/api/projects/status/github/catchorg/Catch2?svg=true)](https://ci.appveyor.com/project/catchorg/catch2)
[![codecov](https://codecov.io/gh/catchorg/Catch2/branch/master/graph/badge.svg)](https://codecov.io/gh/catchorg/Catch2)
[![Try online](https://img.shields.io/badge/try-online-blue.svg)](https://wandbox.org/permlink/vOtfjd7LKmcj4JqD)

<a href="https://github.com/catchorg/Catch2/releases/download/v2.2.0/catch.hpp">The latest version of the single header can be downloaded directly using this link</a>

## 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)
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.

## What's the Catch?

Catch2 stands for C++ Automated Test Cases in a Header and is a
multi-paradigm test framework for C++. which also supports Objective-C
(and maybe C).
It is primarily distributed as a single header file, although certain
extensions may require additional headers.

## 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

## More
* Issues and bugs can be raised on the [Issue tracker on GitHub](https://github.com/catchorg/Catch2/issues)
* 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)
Add html anchor 'top' 2017-08-24 15:21:36 +02:00			`<a id="top"></a>`
Refreshed artwork for Catch2 2017-11-07 12:25:03 +01:00			`![catch logo](artwork/catch2-logo-small.png)`
Try as not first line 2013-03-21 20:21:41 +01:00
Updated badges (again) for Catch2 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)`
Force Travis badge to use status of master branch 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)`
Point AppVeyor status badge at status for this repo Previously it pointed to AppVeyor's test repo status 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)`
Add coverage badge 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)`
v2.2.0 2018-03-07 11:01:06 +01:00			`[![Try online](https://img.shields.io/badge/try-online-blue.svg)](https://wandbox.org/permlink/vOtfjd7LKmcj4JqD)`
added travis status to the readme 2013-08-05 14:50:14 +02:00
v2.2.0 2018-03-07 11:01:06 +01:00			`<a href="https://github.com/catchorg/Catch2/releases/download/v2.2.0/catch.hpp">The latest version of the single header can be downloaded directly using this link</a>`
Last tweak to download text - honest 2014-12-09 20:07:48 +01:00
Added note about Catch2 to readme 2017-11-03 14:18:26 +01:00			`## Catch2 is released!`

v2.1.0 2018-01-10 13:53:04 +01:00			`If you've been using an earlier version of Catch, please see the`
Locked release notes reference to v2.0.1 release 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)`
Added link to Catch2 blog post 2017-11-07 12:27:01 +01:00			`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.`
Added note about Catch2 to readme 2017-11-03 14:18:26 +01:00
Start of new docs 2013-06-03 21:03:39 +02:00			`## What's the Catch?`
Added google group to README 2013-01-28 08:57:27 +01:00
Updated some Catch references to Catch2 2017-11-03 14:05:09 +01:00			`Catch2 stands for C++ Automated Test Cases in a Header and is a`
Small doc updates 2017-08-17 09:28:45 +02:00			`multi-paradigm test framework for C++. which also supports Objective-C`
Updated some Catch references to Catch2 2017-11-03 14:05:09 +01:00			`(and maybe C).`
Small doc updates 2017-08-17 09:28:45 +02:00			`It is primarily distributed as a single header file, although certain`
			`extensions may require additional headers.`
Start of new docs 2013-06-03 21:03:39 +02:00
			`## How to use it`
			`This documentation comprises these three parts:`

Let toplevel links to .md files link to .md#top 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`
Start of new docs 2013-06-03 21:03:39 +02:00
			`## More`
Updated some Catch references to Catch2 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)`
Start of new docs 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)`
Updated some Catch references to Catch2 2017-11-03 14:05:09 +01:00			`* See [who else is using Catch2](docs/opensource-users.md#top)`