CMake by Example is a hands-on introduction to CMake using annotated example projects. Get started with the hello world example or click on any of the links below. You are encouraged to copy-paste bits from these examples into your own projects as needed.

CMake is the de-facto standard for building C++ code, with over 2 million downloads a month. It’s a powerful, comprehensive solution for managing the software build process.

🚩 Basics

• Build an executable
• Build a static library
• Build a shared library
• Build multiple targets
• Conditional if/else
• Print a message
• Print a warning
• Print an error
• Add an include folder
• Set C++ standard
• Set C standard

📚 Libraries

• Use a library via Git submodule
• Use a library via FetchContent
• Use a library via CPM.cmake
• Use a library via Conan
• Use a library via Vcpkg
• Use a library via APT

🧰 Tooling

• Test with GoogleTest
• Test with CTest
• Test with Boost.Test
• Format with clang-format
• Lint with clang-tidy

⚙️ Advanced

• Installers
• Configure files
• Protobuf codegen
• CMake presets
• Subprojects
• Build target if option passed
• Use Clang to compile
• Cross-compiling

---

This project is inspired by Go by Example, JavaScript by Example, Haskell by Example, Deno by Example, C by Example, and Makefile Tutorial by Example.

👀 Want more CMake? Check out onqtam/awesome-cmake!