search

catchorg / Catch2

A modern, C++-native, test framework for unit-tests, TDD and BDD - using C++14, C++17 and later (C++11 support is in v2.x branch, and C++03 on the Catch1.x branch)
https://discord.gg/4CWS9zD
Boost Software License 1.0
18.77k stars 3.06k forks source link

The documentation needs updating for v3 #2050

Open horenmar opened 4 years ago

horenmar commented 4 years ago

As an example, the "Getting started" documentation still talks about CATCH_CONFIG_MAIN macro.

teju85 commented 4 years ago

@horenmar I've been using the single-include approach for a while now. But with latest devel this is not there and also there are many changes to the header files themselves. Can you please point us to anything that'll help us migrate existing codes using v2.x API to devel?

csegarragonz commented 4 years ago

There's also a broken link in docs/tutorial.md (in particular the one pointing to the single header file in https://raw.githubusercontent.com/catchorg/Catch2/master/single_include/catch2/catch.hpp)

sampotter commented 4 years ago

First, thanks for providing a very nice C++ unit testing library that serves as a great alternative to gtest!

Just wanted to let you know that I spent the last hour+ trying to figure out why I couldn't #include <catch/catch2.hpp> after cloning and installing on an Ubuntu 16 machine to test a library I'm developing. It took quite a while to figure out that the devel branch had switched to a new v3 and that v2 had gone into maintenance mode. Very frustrating. I strongly recommend that you put an obvious notice somewhere at the top of devel's README file so that when people "land" on the GitHub page it's clear what's going on.

Thanks!

horenmar commented 4 years ago

There is now a migration guide, and the readme has been updated to point to the old release branch and the migration guide.

maxnoe commented 2 years ago

Is something still missing? The readme still mentions v2.x as being stable and documented, but 3.1 is released (and 3.0 since quite a while).