summaryrefslogtreecommitdiffstats
path: root/Help/guide/tutorial/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Help/guide/tutorial/index.rst')
-rw-r--r--Help/guide/tutorial/index.rst44
1 files changed, 44 insertions, 0 deletions
diff --git a/Help/guide/tutorial/index.rst b/Help/guide/tutorial/index.rst
new file mode 100644
index 0000000..09553cb
--- /dev/null
+++ b/Help/guide/tutorial/index.rst
@@ -0,0 +1,44 @@
+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:: source.txt
+
+|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
+ Installing and Testing
+ Adding System Introspection
+ Adding a Custom Command and Generated File
+ Packaging an Installer
+ Adding Support for a Testing Dashboard
+ Selecting Static or Shared Libraries
+ Adding Generator Expressions
+ 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: