forked from eclipse-cdt/cdt
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Getting Started documentation update.
* 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, and the launch bar. * 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
- Loading branch information
1 parent
9e04dc5
commit c429387
Showing
20 changed files
with
312 additions
and
194 deletions.
There are no files selected for viewing
Binary file added
BIN
+30.6 KB
doc/org.eclipse.cdt.doc.user/images/c_cpp_project_wizard_cmake_properties.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+23.6 KB
doc/org.eclipse.cdt.doc.user/images/c_cpp_project_wizard_makefile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+33.1 KB
doc/org.eclipse.cdt.doc.user/images/c_cpp_project_wizard_makefile_properties.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 52 additions & 0 deletions
52
doc/org.eclipse.cdt.doc.user/src/getting_started/cbs_launchbar.adoc
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
//// | ||
Copyright (c) 2000, 2025 Contributors to the Eclipse Foundation | ||
This program and the accompanying materials | ||
are made available under the terms of the Eclipse Public License 2.0 | ||
which accompanies this distribution, and is available at | ||
https://www.eclipse.org/legal/epl-2.0/ | ||
|
||
SPDX-License-Identifier: EPL-2.0 | ||
//// | ||
|
||
// pull in shared headers, footers, etc | ||
:docinfo: shared | ||
|
||
// support image rendering and table of contents within GitHub | ||
ifdef::env-github[] | ||
:imagesdir: ../../images | ||
:toc: | ||
:toc-placement!: | ||
endif::[] | ||
|
||
// enable support for button, menu and keyboard macros | ||
:experimental: | ||
|
||
// Until ENDOFHEADER the content must match adoc-headers.txt for consistency, | ||
// this is checked by the build in do_generate_asciidoc.sh, which also ensures | ||
// that the checked in html is up to date. | ||
// do_generate_asciidoc.sh can also be used to apply this header to all the | ||
// adoc files. | ||
// ENDOFHEADER | ||
|
||
== Launch Bar | ||
|
||
CBS projects rely on the *LaunchBar*. Make sure the launch bar plugin | ||
is installed and enabled. In the global preferences the launch bar can | ||
be enabled or disabled. | ||
|
||
image:launchbar_preferences.png[Launch Bar preferences] | ||
|
||
The launch bar exists out of several components: | ||
|
||
image:launchbar.png[Launch Bar] | ||
|
||
. Build button, to launch a build. | ||
. Run button, to launch a run. This button will change to a Debug | ||
button in Debug mode. | ||
. Stop button, to stop a Run or Debug session. | ||
. Launch mode selector. To change between Run and Debug mode. | ||
. Launch configuration selector. | ||
. Edit launch configuration. To change the launch configuration | ||
properties. | ||
. Target selector. Not always visible. | ||
. Edit target. |
66 changes: 66 additions & 0 deletions
66
doc/org.eclipse.cdt.doc.user/src/getting_started/cbs_using_existing_code.adoc
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
//// | ||
Copyright (c) 2000, 2025 Contributors to the Eclipse Foundation | ||
This program and the accompanying materials | ||
are made available under the terms of the Eclipse Public License 2.0 | ||
which accompanies this distribution, and is available at | ||
https://www.eclipse.org/legal/epl-2.0/ | ||
|
||
SPDX-License-Identifier: EPL-2.0 | ||
//// | ||
|
||
// pull in shared headers, footers, etc | ||
:docinfo: shared | ||
|
||
// support image rendering and table of contents within GitHub | ||
ifdef::env-github[] | ||
:imagesdir: ../../images | ||
:toc: | ||
:toc-placement!: | ||
endif::[] | ||
|
||
// enable support for button, menu and keyboard macros | ||
:experimental: | ||
|
||
// Until ENDOFHEADER the content must match adoc-headers.txt for consistency, | ||
// this is checked by the build in do_generate_asciidoc.sh, which also ensures | ||
// that the checked in html is up to date. | ||
// do_generate_asciidoc.sh can also be used to apply this header to all the | ||
// adoc files. | ||
// ENDOFHEADER | ||
|
||
== Using existing code | ||
|
||
This tutorial describes how to use existing code for Core Build System | ||
projects. | ||
|
||
Using existing code is done by creating a new **empty** project on top of the | ||
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. | ||
|
||
image:cbs_empty_cmake_project.png[Empty or Existing CMake Project] | ||
|
||
Then in the *New CMake Project* wizard deselect *Use default location* | ||
and set the location of the existing code. | ||
|
||
image:cbs_existing_code_cmake.png[Existing code CMake] | ||
|
||
More information about creating a CMake project is described in | ||
xref:new_cmake_proj.adoc[Creating a CMake project] | ||
|
||
=== Using an existing Makefile project | ||
|
||
Create a Makefile project as described in | ||
xref:new_cbs_makefile_proj.adoc[Creating a Core Build System Makefile project] | ||
with the following changes: | ||
|
||
In the *New Makefile Project* wizard deselect *Use default location* | ||
and set the location of the existing code, and deselect *Create Hello | ||
World Source and Makefile example*. | ||
|
||
image:cbs_existing_code_makefile.png[Existing code Makefile] | ||
|
||
icon:arrow-circle-right[] xref:cbs_launchbar.adoc[Next: Launch Bar] |
This file contains 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
This file contains 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
165 changes: 0 additions & 165 deletions
165
doc/org.eclipse.cdt.doc.user/src/getting_started/cdt_w_newproj.adoc
This file was deleted.
Oops, something went wrong.
41 changes: 41 additions & 0 deletions
41
doc/org.eclipse.cdt.doc.user/src/getting_started/index_cbs.adoc
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
//// | ||
Copyright (c) 2000, 2025 Contributors to the Eclipse Foundation | ||
This program and the accompanying materials | ||
are made available under the terms of the Eclipse Public License 2.0 | ||
which accompanies this distribution, and is available at | ||
https://www.eclipse.org/legal/epl-2.0/ | ||
|
||
SPDX-License-Identifier: EPL-2.0 | ||
//// | ||
|
||
// pull in shared headers, footers, etc | ||
:docinfo: shared | ||
|
||
// support image rendering and table of contents within GitHub | ||
ifdef::env-github[] | ||
:imagesdir: ../../images | ||
:toc: | ||
:toc-placement!: | ||
endif::[] | ||
|
||
// enable support for button, menu and keyboard macros | ||
:experimental: | ||
|
||
// Until ENDOFHEADER the content must match adoc-headers.txt for consistency, | ||
// this is checked by the build in do_generate_asciidoc.sh, which also ensures | ||
// that the checked in html is up to date. | ||
// do_generate_asciidoc.sh can also be used to apply this header to all the | ||
// adoc files. | ||
// ENDOFHEADER | ||
|
||
= Core Build System contents | ||
|
||
xref:core_build_system.adoc[Core Build System] | ||
|
||
xref:new_cmake_proj.adoc[Creating a CMake project] | ||
|
||
xref:new_cbs_makefile_proj.adoc[Creating a Core Build System Makefile project] | ||
|
||
xref:cbs_using_existing_code.adoc[Using existing code] | ||
|
||
xref:cbs_launchbar.adoc[Launch Bar] |
Oops, something went wrong.