docs: add CMake getting-started guide for new users#3105
Open
leno23 wants to merge 2 commits into
Open
Conversation
Explain project layout, when to use Catch2WithMain vs Catch2, and a minimal CMakeLists.txt example. Link from the tutorial. Fixes catchorg#2351.
Use lowercase include(FetchContent) per CMake conventions.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## devel #3105 +/- ##
==========================================
+ Coverage 91.26% 91.31% +0.04%
==========================================
Files 204 204
Lines 8905 8905
==========================================
+ Hits 8127 8131 +4
+ Misses 778 774 -4 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a Getting started with CMake section that answers common first-time questions from #2351:
CMakeLists.txtin the project root)CMakeLists.txt+test.cpp)Catch2::Catch2WithMainvsCatch2::Catch2(custommain)CMakeLists.txtand build/run commandsAlso links to this section from
tutorial.md.Fixes #2351.
Test plan
Made with Cursor