catch2/README.md

38 lines
2.1 KiB
Markdown
Raw Normal View History

2017-08-24 15:21:36 +02:00
<a id="top"></a>
2017-11-07 12:25:03 +01:00
![catch logo](artwork/catch2-logo-small.png)
2013-03-21 20:21:41 +01:00
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)
[![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)
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)
2020-05-25 15:13:18 +02:00
[![Try online](https://img.shields.io/badge/try-online-blue.svg)](https://wandbox.org/permlink/QdDfqVqDGRuwcduN)
2018-07-01 20:48:21 +02:00
[![Join the chat in Discord: https://discord.gg/4CWS9zD](https://img.shields.io/badge/Discord-Chat!-brightgreen.svg)](https://discord.gg/4CWS9zD)
2013-08-05 14:50:14 +02:00
2020-05-25 15:13:18 +02:00
<a href="https://github.com/catchorg/Catch2/releases/download/v2.12.2/catch.hpp">The latest version of the single header can be downloaded directly using this link</a>
2014-12-09 20:07:48 +01:00
2017-11-03 14:18:26 +01:00
## Catch2 is released!
2018-01-10 13:53:04 +01:00
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)
2019-03-08 09:56:00 +01:00
before moving to Catch2. You might also like to read [this blog post](https://levelofindirection.com/blog/catch2-released.html) for more details.
2017-11-03 14:18:26 +01:00
2013-06-03 21:03:39 +02:00
## What's the Catch?
2013-01-28 08:57:27 +01:00
2019-07-02 20:43:37 +02:00
Catch2 is a multi-paradigm test framework for C++. which also supports
Objective-C (and maybe C).
2017-08-17 09:28:45 +02:00
It is primarily distributed as a single header file, although certain
extensions may require additional headers.
2013-06-03 21:03:39 +02:00
## 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
2013-06-03 21:03:39 +02:00
## More
* Issues and bugs can be raised on the [Issue tracker on GitHub](https://github.com/catchorg/Catch2/issues)
2018-07-01 20:48:21 +02:00
* 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)
* See [who else is using Catch2](docs/opensource-users.md#top)