Blame - README.md - platform/external/catch2

blob: 535ac6ecdd845de5c7aba58dfde43e616354b7bd [file] [log] [blame] [view]

Martin Moene	e822505	2017-08-24 15:21:36 +0200	[diff] [blame]	1	<a id="top"></a>
Phil Nash	3a4c765	2017-11-07 11:25:03 +0000	[diff] [blame]	2	![catch logo](artwork/catch2-logo-small.png)
Phil Nash	22b7921	2013-03-21 19:21:41 +0000	[diff] [blame]	3
Phil Nash	07ac9b9	2017-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ý	0cf05d5	2017-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ý	11887fb	2017-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ý	3979845	2017-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ý	7c37501	2019-04-22 23:15:59 +0200	[diff] [blame]	8	[![Try online](https://img.shields.io/badge/try-online-blue.svg)](https://wandbox.org/permlink/rsEsNO9M0flb5NlQ)
Martin Hořeňovský	e69c7ce	2018-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
Kosta	7fcde92	2013-08-05 14:50:14 +0200	[diff] [blame]	11
Martin Hořeňovský	7c37501	2019-04-22 23:15:59 +0200	[diff] [blame]	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>
Phil Nash	d8e3c1f	2014-12-09 19:07:48 +0000	[diff] [blame]	13
Phil Nash	cf76a79	2017-11-03 13:18:26 +0000	[diff] [blame]	14	## Catch2 is released!
				15
Martin Hořeňovský	cd76f57	2018-01-10 13:53:04 +0100	[diff] [blame]	16	If you've been using an earlier version of Catch, please see the
Phil Nash	53f6d3f	2017-11-03 13:31:59 +0000	[diff] [blame]	17	Breaking Changes section of [the release notes](https://github.com/catchorg/Catch2/releases/tag/v2.0.1)
Clare Macrae	0424c9a	2019-03-08 08:56:00 +0000	[diff] [blame]	18	before moving to Catch2. You might also like to read [this blog post](https://levelofindirection.com/blog/catch2-released.html) for more details.
Phil Nash	cf76a79	2017-11-03 13:18:26 +0000	[diff] [blame]	19
Phil Nash	130ec98	2013-06-03 20:03:39 +0100	[diff] [blame]	20	## What's the Catch?
Phil Nash	2f92db9	2012-10-28 12:15:34 +0000	[diff] [blame]	21
Phil Nash	7423a48	2017-11-03 13:05:09 +0000	[diff] [blame]	22	Catch2 stands for C++ Automated Test Cases in a Header and is a
Phil Nash	0b52dbe	2017-08-17 08:28:45 +0100	[diff] [blame]	23	multi-paradigm test framework for C++. which also supports Objective-C
Phil Nash	7423a48	2017-11-03 13:05:09 +0000	[diff] [blame]	24	(and maybe C).
Phil Nash	0b52dbe	2017-08-17 08:28:45 +0100	[diff] [blame]	25	It is primarily distributed as a single header file, although certain
				26	extensions may require additional headers.
Phil Nash	130ec98	2013-06-03 20:03:39 +0100	[diff] [blame]	27
				28	## How to use it
				29	This documentation comprises these three parts:
				30
Martin Moene	6c09b45	2017-08-24 15:33:38 +0200	[diff] [blame]	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
Phil Nash	130ec98	2013-06-03 20:03:39 +0100	[diff] [blame]	34
Phil Nash	130ec98	2013-06-03 20:03:39 +0100	[diff] [blame]	35	## More
Phil Nash	7423a48	2017-11-03 13:05:09 +0000	[diff] [blame]	36	* Issues and bugs can be raised on the [Issue tracker on GitHub](https://github.com/catchorg/Catch2/issues)
Martin Hořeňovský	e69c7ce	2018-07-01 20:48:21 +0200	[diff] [blame]	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)
Phil Nash	7423a48	2017-11-03 13:05:09 +0000	[diff] [blame]	38	* See [who else is using Catch2](docs/opensource-users.md#top)