3. Tutorials

If you reached this section it means you can handle basic configuration. It’s time to see everything in detail and add more features.

Note

In provided examples:

• CMake will be run in command-line format but CMake-GUI will work in a similar way, if behavior differs it will be noted explicitly

• For the host platform Linux is chosen, use analogous commands if you use another host. E.g. use dir _builds on Windows instead of ls _builds

• Unix Makefiles will be used as the generator. On *nix platforms this is the default generator. Peculiarities of other generators will be described explicitly

• 3.1. CMake stages
  • 3.1.1. Configure step
  • 3.1.2. Generate step
  • 3.1.3. Build step
• 3.2. Out-of-source build
  • 3.2.1. Multiple configurations
  • 3.2.2. VCS friendly
  • 3.2.3. Other notes
• 3.3. Workflow
  • 3.3.1. Makefile example
  • 3.3.2. Visual Studio example
  • 3.3.3. UML activity diagram
  • 3.3.4. Suspicious behavior
• 3.4. Version and policies
  • 3.4.1. cmake_minimum_required
  • 3.4.2. CMake policies
  • 3.4.3. Summary
• 3.5. Project declaration
  • 3.5.1. Tools discovering
  • 3.5.2. Languages
  • 3.5.3. Variables
  • 3.5.4. When not declared
  • 3.5.5. Summary
• 3.6. Variables
  • 3.6.1. Regular variables
  • 3.6.2. Cache variables
  • 3.6.3. Environment variables
• 3.7. CMake listfiles
  • 3.7.1. Subdirectories
  • 3.7.2. Include modules
  • 3.7.3. Common variables
  • 3.7.4. Scripts
• 3.8. Control structures
  • 3.8.1. Conditional blocks
  • 3.8.2. Loops
  • 3.8.3. Functions
• 3.9. Executables
  • 3.9.1. Simple
  • 3.9.2. Duplicates
• 3.10. Tests
  • 3.10.1. Multi-config testing
  • 3.10.2. Verbose output
  • 3.10.3. Subset of tests
• 3.11. Libraries
  • 3.11.1. Static
  • 3.11.2. Shared
  • 3.11.3. Static + shared
  • 3.11.4. Symbols
• 3.12. Pseudo targets
  • 3.12.1. Imported targets
  • 3.12.2. Alias targets
  • 3.12.3. Interface targets
• 3.13. Collecting sources
  • 3.13.1. Avoid globbing
  • 3.13.2. Project layout
• 3.14. Usage requirements
  • 3.14.1. Compile definitions
  • 3.14.2. Include directories
  • 3.14.3. Link libraries
• 3.15. Build types
  • 3.15.1. Detect Multi/Single
• 3.16. configure_file
• 3.17. Install
  • 3.17.1. Library
  • 3.17.2. Header-only library
  • 3.17.3. Library with dependencies
  • 3.17.4. Optional dependencies
  • 3.17.5. CMake modules
  • 3.17.6. Export header
  • 3.17.7. RPATH
  • 3.17.8. Version
  • 3.17.9. CMAKE_INSTALL_PREFIX
  • 3.17.10. Layout
  • 3.17.11. Samples
  • 3.17.12. Managing dependencies
• 3.18. Toolchain
  • 3.18.1. Globals
• 3.19. Generator expressions
• 3.20. Properties
• 3.21. Packing
• 3.22. Continuous integration
  • 3.22.1. Travis
  • 3.22.2. AppVeyor