Issue with documentation

Report any problems with CopperSpice
Post Reply
CandL
Posts: 36
Joined: Mon Oct 14 2019 6:37 pm

Issue with documentation

Post by CandL »

I was looking at the page "CopperSpice Project Using CMake" (https://www.copperspice.com/docs/cs_overview/sample-cs-cmake.html)

You have in red the words CMakeLists.txt and HelloLunch, these are not links ... but the CMakelists.txt are on the same page, ok this is fine.

The "Hellolunch" refers to a project but provides no directional info on how to find it. After 10 minutes of looking for a main.cpp (or main_window.cpp) for a HelloLunch project I gave up.

A google search on "github hellolunch" produces 2 results both copperspice issue reports.

Is there a "HelloLunch" app?

barbara
Posts: 135
Joined: Sat Apr 04 2015 2:32 am

Re: Issue with documentation

Post by barbara »

You have in red the words CMakeLists.txt and HelloLunch, these are not links
These are actually in orange to show emphasis, they are not intended to be links. As you did mention the text for the build files are on this page so this is not an issue.
The "Hellolunch" refers to a project but provides no directional info on how to find it.
This is not a real project but rather a fictitious project and the only purpose is to show CMake build files. Our docs do refer to our KitchenSink project as one you should look at for more information. You can also look at DoxyPress for examples of build files.

barbara
Posts: 135
Joined: Sat Apr 04 2015 2:32 am

Re: Issue with documentation

Post by barbara »

To help out with any confusion we will update the CS Overview docs to indicate that HelloLunch is not a real project. Thanks for helping us see this would be a good idea.

Keep on letting us know how to improve.

Barbara

Post Reply