qt5base-lts/doc/global/includes/cli-build-cmake.qdocinc
Lucie Gérard 05fc3aef53 Use SPDX license identifiers
Replace the current license disclaimer in files by
a SPDX-License-Identifier.
Files that have to be modified by hand are modified.
License files are organized under LICENSES directory.

Task-number: QTBUG-67283
Change-Id: Id880c92784c40f3bbde861c0d93f58151c18b9f1
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Lars Knoll <lars.knoll@qt.io>
Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
2022-05-16 16:37:38 +02:00

43 lines
1.4 KiB
Plaintext

// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
//! [cli-build-cmake]
\section1 Building and Running from the Command Line
To build an example application from the command line, create a build
directory for it. Switch to the build directory and run \c qt-cmake to
configure your project for building. If the project is configured
successfully, the generated files enable you to build the project.
\badcode
md <build_directory>
cd <build_directory>
<qt_installation_directory>\bin\qt-cmake -GNinja <source_directory>
<generator>
\endcode
The commands create an executable in the build directory. The \c CMake
tool reads the project file and produces instructions for how to build
the application. The generator then uses the instructions to produce
the executable binary.
For example, to build the Notepad example on Windows, when using Ninja
as the generator, enter the following commands:
\badcode \QtVersion
md notepad-build
cd notepad-build
C:\Qt\\1\msvc2019_64\bin\qt-cmake -GNinja C:\Examples\notepad
ninja
\endcode
If you do not use Ninja as the generator, use the generator-independent
CMake command to build the application instead of \c ninja:
\badcode
cmake --build
\endcode
//! [cli-build-cmake]