cmake/Help/guide/tutorial/index.rst

45 lines
1.1 KiB
ReStructuredText
Raw Normal View History

2020-02-01 23:06:01 +01:00
CMake Tutorial
**************
2021-09-14 00:13:48 +02:00
Introduction
============
2020-02-01 23:06:01 +01:00
The CMake tutorial provides a step-by-step guide that covers common build
system issues that CMake helps address. Seeing how various topics all
2021-09-14 00:13:48 +02:00
work together in an example project can be very helpful.
Steps
=====
2022-05-25 20:56:39 +02:00
.. include:: source.txt
|tutorial_source|
2021-09-14 00:13:48 +02:00
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
2022-11-16 20:14:03 +01:00
Adding Generator Expressions
2021-09-14 00:13:48 +02:00
Installing and Testing
2022-11-16 20:14:03 +01:00
Adding Support for a Testing Dashboard
2021-09-14 00:13:48 +02:00
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: