Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorMartin Hořeňovský2021-11-16 16:22:46 +0100
committerMartin Hořeňovský2021-11-16 23:46:22 +0100
commitd32e89eb84790f2ecc7e13ba16cec3748cb6f28d (patch)
tree72809d0b9c6bc240e5d1922d3d455b18f29f672f
parentce6aca81ad1a70f79c9fd7fb9af8ff5872a9153b (diff)
downloadcatch3-d32e89eb84790f2ecc7e13ba16cec3748cb6f28d.tar.gz
Reorganize the main readme
-rw-r--r--README.md25
1 files changed, 13 insertions, 12 deletions
diff --git a/README.md b/README.md
index a9c08138..09df5735 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,17 @@
[![Join the chat in Discord: https://discord.gg/4CWS9zD](https://img.shields.io/badge/Discord-Chat!-brightgreen.svg)](https://discord.gg/4CWS9zD)
+## 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 v3 is being developed!
You are on the `devel` branch, where the next major version, v3, of
@@ -26,17 +37,6 @@ guidelines on getting started, and collects most common migration
problems.
-## 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.
-
-
## How to use it
This documentation comprises these three parts:
@@ -48,4 +48,5 @@ This documentation comprises these three parts:
## 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 [our Discord](https://discord.gg/4CWS9zD)
-* See [who else is using Catch2](docs/opensource-users.md#top)
+* See who else is using Catch2 in [Open Source Software](docs/opensource-users.md#top)
+or [commercially](docs/commercial-users.md#top).