Description
Improve documentation for first time users.
Additional context
I am just starting to use Catch.
The first line of the tutorial presented on Catch's first page (https://github.com/catchorg/Catch2/blob/devel/docs/tutorial.md#top) says that ideally I should be using Catch2 through its "CMake integration" (https://github.com/catchorg/Catch2/blob/devel/docs/cmake-integration.md#top). I faithfully follow the "ideal" path.
On the second paragraph of the "CMake integration" page I start to get lost: If you do not need custom main function, you should...
Do I need a custom main function? Why would anyone need one? How can a person live without one? I have no idea at all and the text neither explains any of this nor provides any kind of sensible default orientation (If you don't know what we are talking about just pretend you... or something similar).
On the third paragraph it is presented a block of code and the reader gets to know that it should be enough to do the block of code. What is to do a block of code? Should I include this code in some pre existing file? Which file? In what part of said file? Or should I create a new file with the proposed content? Which file? Where should I put it?
It seems to me that this documentation that is presented to new users as their first contact with Catch is rather terse making lot's of assumptions not that reasonable for first time users.
Description
Improve documentation for first time users.
Additional context
I am just starting to use Catch.
The first line of the tutorial presented on Catch's first page (https://github.com/catchorg/Catch2/blob/devel/docs/tutorial.md#top) says that ideally I should be using Catch2 through its "CMake integration" (https://github.com/catchorg/Catch2/blob/devel/docs/cmake-integration.md#top). I faithfully follow the "ideal" path.
On the second paragraph of the "CMake integration" page I start to get lost: If you do not need custom main function, you should...
Do I need a custom main function? Why would anyone need one? How can a person live without one? I have no idea at all and the text neither explains any of this nor provides any kind of sensible default orientation (If you don't know what we are talking about just pretend you... or something similar).
On the third paragraph it is presented a block of code and the reader gets to know that it should be enough to do the block of code. What is to do a block of code? Should I include this code in some pre existing file? Which file? In what part of said file? Or should I create a new file with the proposed content? Which file? Where should I put it?
It seems to me that this documentation that is presented to new users as their first contact with Catch is rather terse making lot's of assumptions not that reasonable for first time users.