mirror of https://github.com/catchorg/Catch2.git
38 lines
2.1 KiB
Markdown
38 lines
2.1 KiB
Markdown
<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=v2.x)](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/v2.x/graph/badge.svg)](https://codecov.io/gh/catchorg/Catch2)
|
|
[![Try online](https://img.shields.io/badge/try-online-blue.svg)](https://wandbox.org/permlink/6JUH8Eybx4CtvkJS)
|
|
[![Join the chat in Discord: https://discord.gg/4CWS9zD](https://img.shields.io/badge/Discord-Chat!-brightgreen.svg)](https://discord.gg/4CWS9zD)
|
|
|
|
|
|
<a href="https://github.com/catchorg/Catch2/releases/download/v2.13.2/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](https://levelofindirection.com/blog/catch2-released.html) for more details.
|
|
|
|
## What's the Catch?
|
|
|
|
Catch2 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) or our [Discord](https://discord.gg/4CWS9zD)
|
|
* See [who else is using Catch2](docs/opensource-users.md#top)
|