Getting Started documentation update. #1056
Conversation
|
Hi @jonahgraham @jld01 @betamaxbandit , Would you like to review this change? It is not finished yet. I'm going to add topics about Building, Running, and Debugging. You can start adding comments. I separated CBS and MBS.
|
Test Results 601 files ±0 601 suites ±0 13m 28s ⏱️ +4s For more details on these failures, see this check. Results for commit 378d553. ± Comparison against base commit 5e62200. ♻️ This comment has been updated with latest results. |
|
I'll have a look soon - in the meantime since I don't have an auto comment, the docs are available from this build in https://github.com/eclipse-cdt/cdt/actions/runs/12933695063?pr=1056 (docs link near the bottom) |
| image:launchbar.png[Launch Bar] | ||
|
|
||
| . Build button, to launch a build. | ||
| . Run button, to launch a run. This button will change to a Debug |
There was a problem hiding this comment.
Should we mention profile mode somewhere here too?
There was a problem hiding this comment.
I was doubting about mentioning it in "getting started". The Profile mode is not in the launch mode selector before you run profiling. Profiling only works properly in Makefile projects, not in CMake. And you need to have the profiling plugin installed before it is available at all. I think it is more an advanced topic.
|
|
||
| == Launch Bar | ||
|
|
||
| CBS projects rely on the *LaunchBar*. Make sure the launch bar plugin |
There was a problem hiding this comment.
| CBS projects rely on the *LaunchBar*. Make sure the launch bar plugin | |
| Core Build System (CBS) projects rely on the *Launch Bar*. Make sure the _LaunchBar UI_ feature |
| This tutorial describes how to use existing code for Core Build System | ||
| projects. |
There was a problem hiding this comment.
| This tutorial describes how to use existing code for Core Build System | |
| projects. | |
| This tutorial describes how to create a new Core Build System | |
| project for use with existing code. |
| === Using an existing CMake project | ||
|
|
||
| To create an empty CMake project select the template *Empty or Existing CMake | ||
| Project* in the *New C/{cpp} Project* wizard. |
There was a problem hiding this comment.
Need to clarify the distinction between a "CMake project" (IDE independent source code) and a "CMake project" (metadata created by CDT).
|
|
||
| image:cbs_empty_cmake_project.png[Empty or Existing CMake Project] | ||
|
|
||
| Then in the *New CMake Project* wizard deselect *Use default location* |
There was a problem hiding this comment.
| Then in the *New CMake Project* wizard deselect *Use default location* | |
| In the *New CMake Project* wizard deselect *Use default location* |
| === Using an existing Makefile project | ||
|
|
||
| Create a Makefile project as described in |
There was a problem hiding this comment.
Similarly, distinguish the two uses of "Makefile project" here.
| In the *New Makefile Project* wizard deselect *Use default location* | ||
| and set the location of the existing code, and deselect *Create Hello |
There was a problem hiding this comment.
| In the *New Makefile Project* wizard deselect *Use default location* | |
| and set the location of the existing code, and deselect *Create Hello | |
| In the *New Makefile Project* wizard deselect *Use default location*, | |
| set the location of the existing code, and deselect *Create Hello |
|
|
||
|
|
There was a problem hiding this comment.
I think multiple empty lines (here and elsewhere) are being interpreted as the end of the numbered list. So the next numbered list item will be item "1" again. Try a single empty line only.
There was a problem hiding this comment.
A few comments on your work-in-progress, @ewaterlander. Great to see the documentation being updated.
ewaterlander
force-pushed
the
getting_started
branch
from
c429387 to
9526216
Compare
|
I added three new topics: Building, Running, and Debugging a project. Now the change is complete. I will process the comments on Monday. Thanks. Have a nice weekend! |
* Put Core Build and Managed Build items in separate topics. * Added two images to Creating a CMake project. * Added new pages about creating a CBS Makefile project, using existing code, launch bar, building, running, and debbuggin a project. * Renamed "Creating a simple application" to "Creating a Managed Build System Makefile project" and replaced two images. * Removed "Creating a Makefile project", because it was duplicate information. Fixes eclipse-cdt#992
ewaterlander
force-pushed
the
getting_started
branch
from
9526216 to
378d553
Compare
Fixes #992