catchorg / catchorg/Catch2

Documentation unclear on how to use

Open
#2,470 4 comments 1 reaction 0 assignees View on GitHub
Dominant language
C++
Stars
21.5k
Forks
3.5k
Avg merge
3d 16h
Merged PRs (30d)
2

Description

As an unexperienced C++ programmer, the instructions on how to get Catch are confusing and seemingly scattered throughout several files.
_/docs/why-catch.md_ tells me to just "Just download two files, add them into your project and you're away." which makes me think I can just get the .cpp and .hpp from the releases and drop them in my project.
However, _/docs/tutorial.md_ sends me to _/docs/cmake-integration.md_ which tells me to install it via a package manager or clone the repository.

So which is it? And should this information not be grouped together in a more general installation file?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.