index.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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. Getting Started with CMake
  18. CMake Language Fundamentals
  19. Configuration and Cache Variables
  20. In-Depth CMake Target Commands
  21. In-Depth CMake Library Concepts
  22. In-Depth System Introspection
  23. Custom Commands and Generated Files
  24. Testing and CTest
  25. Installation Commands and Concepts
  26. Finding Dependencies
  27. Miscellaneous Features
  28. ..
  29. Whenever a step above is renamed or removed, leave forwarding text in
  30. its original document file, and list it below to preserve old links
  31. to cmake.org/cmake/help/latest/ URLs.
  32. .. toctree::
  33. :maxdepth: 1
  34. :hidden:
  35. A Basic Starting Point
  36. Adding a Library
  37. Adding Usage Requirements for a Library
  38. Adding Generator Expressions
  39. Installing and Testing
  40. Adding Support for a Testing Dashboard
  41. Adding System Introspection
  42. Adding a Custom Command and Generated File
  43. Packaging an Installer
  44. Selecting Static or Shared Libraries
  45. Adding Export Configuration
  46. Packaging Debug and Release