mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-13 09:49:42 -06:00
5473a45fd8
Restore commit4cb616fed6(Tutorial: Provide a source archive when published on cmake.org, 2022-04-27, v3.23.2~22^2). Its effects were accidentally reverted by commit9784834b4c(Help: Use `*.rst` extension for included files, 2025-04-07, v4.1.0-rc1~354^2). Reported-by: Vito Gamberini <vito.gamberini@kitware.com>
45 lines
1.1 KiB
ReStructuredText
45 lines
1.1 KiB
ReStructuredText
CMake Tutorial
|
|
**************
|
|
|
|
Introduction
|
|
============
|
|
|
|
The CMake tutorial provides a step-by-step guide that covers common build
|
|
system issues that CMake helps address. Seeing how various topics all
|
|
work together in an example project can be very helpful.
|
|
|
|
Steps
|
|
=====
|
|
|
|
.. include:: include/source.rst
|
|
|
|
|tutorial_source|
|
|
Each step has its own subdirectory containing code that may be used as a
|
|
starting point. The tutorial examples are progressive so that each step
|
|
provides the complete solution for the previous step.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
A Basic Starting Point
|
|
Adding a Library
|
|
Adding Usage Requirements for a Library
|
|
Adding Generator Expressions
|
|
Installing and Testing
|
|
Adding Support for a Testing Dashboard
|
|
Adding System Introspection
|
|
Adding a Custom Command and Generated File
|
|
Packaging an Installer
|
|
Selecting Static or Shared Libraries
|
|
Adding Export Configuration
|
|
Packaging Debug and Release
|
|
|
|
..
|
|
Whenever a step above is renamed or removed, leave forwarding text in
|
|
its original document file, and list it below to preserve old links
|
|
to cmake.org/cmake/help/latest/ URLs.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:hidden:
|