index.rst 1.2 KB

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