Help/guide/tutorial/index.rst

   1 CMake Tutorial
   2 **************
   3
   4 Introduction
   5 ============
   6
   7 The CMake tutorial provides a step-by-step guide that covers common build
   8 system issues that CMake helps address. Seeing how various topics all
   9 work together in an example project can be very helpful.
  10
  11 Steps
  12 =====
  13
  14 .. include:: source.txt
  15
  16 |tutorial_source|
  17 Each step has its own subdirectory containing code that may be used as a
  18 starting point. The tutorial examples are progressive so that each step
  19 provides the complete solution for the previous step.
  20
  21 .. toctree::
  22   :maxdepth: 2
  23
  24   A Basic Starting Point
  25   Adding a Library
  26   Adding Usage Requirements for a Library
  27   Installing and Testing
  28   Adding System Introspection
  29   Adding a Custom Command and Generated File
  30   Packaging an Installer
  31   Adding Support for a Testing Dashboard
  32   Selecting Static or Shared Libraries
  33   Adding Generator Expressions
  34   Adding Export Configuration
  35   Packaging Debug and Release
  36
  37 ..
  38   Whenever a step above is renamed or removed, leave forwarding text in
  39   its original document file, and list it below to preserve old links
  40   to cmake.org/cmake/help/latest/ URLs.
  41
  42 .. toctree::
  43   :maxdepth: 1
  44   :hidden: