13.1K ·GitHub
What is this?
A tutorial repository of example CMake projects, laid out from basic to advanced, showing how to use modern CMake for building, testing, and packaging C++ software.
A tutorial repository of example CMake projects, laid out from basic to advanced, showing how to use modern CMake for building, testing, and packaging C++ software.Is this a library or a collection of example projects?It is a collection of standalone example CMake projects, each in its own folder, meant to be read and tried as a step-by-step tutorial rather than imported as a library.
It is a collection of standalone example CMake projects, each in its own folder, meant to be read and tried as a step-by-step tutorial rather than imported as a library.How do I try out the examples?Install CMake and a C++ compiler, then clone the repo, cd into any example directory, and build it; a 'test.sh' script can also run the full set of examples inside a provided Docker container.
Install CMake and a C++ compiler, then clone the repo, cd into any example directory, and build it; a 'test.sh' script can also run the full set of examples inside a provided Docker container.What do I need installed before building the examples?CMake v3.5 or newer, a C++ compiler (gcc by default), and make; some specific examples additionally need tools like Boost, protobuf, cppcheck, clang, ninja-build, or conan.
CMake v3.5 or newer, a C++ compiler (gcc by default), and make; some specific examples additionally need tools like Boost, protobuf, cppcheck, clang, ninja-build, or conan.Will these examples work on any CMake version?This branch targets CMake 3.5 and later; separate branches exist for examples written against CMake 2.x and 3.0.
This branch targets CMake 3.5 and later; separate branches exist for examples written against CMake 2.x and 3.0.Can I run these examples outside Ubuntu/Linux?They have been tested on Ubuntu 16.04 and should work on any Linux system with CMake v3.5+; CMake itself is cross-platform (supports make, Xcode, Visual Studio), but the install instructions given are Ubuntu-specific.
They have been tested on Ubuntu 16.04 and should work on any Linux system with CMake v3.5+; CMake itself is cross-platform (supports make, Xcode, Visual Studio), but the install instructions given are Ubuntu-specific.What topics do the examples cover beyond basic builds?They progress into testing with CTest, Google Test and Catch, packaging with CPack, static analysis via Cppcheck and clang, code formatting with clang-format, and dependency usage like Boost and Conan.
They progress into testing with CTest, Google Test and Catch, packaging with CPack, static analysis via Cppcheck and clang, code formatting with clang-format, and dependency usage like Boost and Conan.Is there an easier way to test all examples without installing everything manually?Yes, Docker images with all requirements and various CMake versions are published to Docker Hub (matrim/cmake-examples), and a test.sh script can run the full set of examples inside a container.
Yes, Docker images with all requirements and various CMake versions are published to Docker Hub (matrim/cmake-examples), and a test.sh script can run the full set of examples inside a container.How are the examples organized for a beginner?They start very basic and gradually increase in complexity, with later examples building on concepts introduced in earlier ones, so a beginner can work through them roughly in order.
They start very basic and gradually increase in complexity, with later examples building on concepts introduced in earlier ones, so a beginner can work through them roughly in order.What are similar projects?tutorials, yoga, googletest, cppinsights, coost, truffle, vcpkg, YouCompleteMe
tutorials, yoga, googletest, cppinsights, coost, truffle, vcpkg, YouCompleteMeWhich topics is it in?clang, unit-testing, cmake, build-tool, static-analysis, testing, cpp, tutorial, education, docker, cross-platform, mit
clang, unit-testing, cmake, build-tool, static-analysis, testing, cpp, tutorial, education, docker, cross-platform, mit