From d7ced69db2c24b712f0f6af001643bf6705c6151 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Ho=C5=99e=C5=88ovsk=C3=BD?= Date: Fri, 30 Oct 2020 15:31:41 +0100 Subject: [PATCH] Update README.md to point to v2 branch --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ec269c06..294cfb6b 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,26 @@ [![Join the chat in Discord: https://discord.gg/4CWS9zD](https://img.shields.io/badge/Discord-Chat!-brightgreen.svg)](https://discord.gg/4CWS9zD) -## Catch2 is released! +## Catch2 v3 is being developed! -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. +You are on the `devel` branch, where the next major version, v3, of +Catch2 is being developed. As it is a significant rework, you will +find that parts of this documentation are likely still stuck on v2. -## What's the Catch? +For stable (and documentation-matching) version of Catch2, [go to the +`v2.x` branch](https://github.com/catchorg/Catch2/tree/v2.x). + + +## What's the Catch2? + +Catch2 is mainly a unit testing framework for C++, but it also +provides basic micro-benchmarking features, and simple BDD macros. + +Catch2's main advantage is that using it is both simple and natural. +Tests autoregister themselves and do not have to be named with valid +identifiers, assertions look like normal C++ code, and sections provide +a nice way to share set-up and tear-down code in tests. -Catch2 is a multi-paradigm test framework for C++. ## How to use it This documentation comprises these three parts: @@ -26,6 +37,7 @@ This documentation comprises these three parts: * [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)