Skip to content

Commit

Permalink
Add "Creating a CMake Project" help page
Browse files Browse the repository at this point in the history
  • Loading branch information
jld01 committed Nov 12, 2024
1 parent fb20d6c commit 9b6bb07
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
68 changes: 68 additions & 0 deletions doc/org.eclipse.cdt.doc.user/src/asciidoc/new_cmake_proj.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
////
Copyright (c) 2000-2024 QNX Software Systems and others
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

Contributors:
QNX Software Systems - original makefile project content
John Dallaway - initial CMake project content (#935)
////

// 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:

= Creating a CMake project

This tutorial describes the process of creating a new C/C++ project that includes a CMakeLists.txt file.

You need to create a project to contain your source code and related files.
A project has an associated builder that can incrementally compile source files as they are changed.

To create a project:

. Select menu:File[New > Project].

+
When you create a new project, you are required to specify the project type.
This project type will determine the toolchain, data, and tabs that the CDT uses/displays.

. Select the type of project to create. For this tutorial, expand the *C/{cpp}* folder and select *C/C++ Project*.
. Click btn:[Next].

+
The *C/C++ Project* wizard opens:

+
image:c_cpp_project_wizard.png[width=515]

+
By default, the CDT presents all *C/C++ Project* templates.

. Select the *CMake* template filter and choose from the following *CMake* project templates:

+
- *CMake Project* - provides a simple C++ Hello World executable application project with main() and a supporting CMakeLists.txt file.
- *Empty or Existing CMake Project* - provides an empty executable application project suitable for importing existing source and CMakeLists.txt files.

. Click btn:[Next].
. In the *Project name* field, provide a name for the new project.
. Leave the *Use Default Location* option selected.
. Click btn:[Finish].
. If a message box prompts you to change perspectives, click btn:[Yes].

Your new project displays in the Project Explorer view.
Your project may be empty because you have not yet created files for your project.
You can now start writing the code for your application or importing code from elsewhere.

icon:arrow-circle-right[] link:pass:[../getting_started/cdt_w_newcpp.htm][Next: Creating your C++ file]
1 change: 1 addition & 0 deletions doc/org.eclipse.cdt.doc.user/topics_Getting_Started.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<topic label="Preparing the Workbench" href="getting_started/cdt_w_prepare_workbench.htm"/>
<topic label="Creating a simple application" href="getting_started/cdt_w_basic.htm"/>
<topic label="Creating a Makefile project" href="getting_started/cdt_w_newproj.htm"/>
<topic label="Creating a CMake project" href="html/new_cmake_proj.html"/>
<topic label="Importing an existing project" href="getting_started/cdt_w_import.htm"/>
<topic href="getting_started/cdt_w_newcpp.htm" label="Creating a C++ file"/>
<topic href="getting_started/cdt_w_newmake.htm" label="Creating a makefile"/>
Expand Down

0 comments on commit 9b6bb07

Please sign in to comment.