cmake-init
A sophisticated CMake template for modern C and C++ projects, providing best practices for cross-platform development.
What is cmake-init?
cmake-init is a sophisticated copy-and-paste template for setting up modern C and C++ projects using CMake. It provides a collection of CMake best practices to handle all aspects of software development, including programming, testing, quality assurance, deployment, and documentation. The template is designed to be modular, flexible, and idiomatic, ensuring reliable and cross-platform project setups.
C and C++ developers and teams who need a robust, standardized starting point for new projects, especially those targeting Windows, macOS, and Linux platforms.
Developers choose cmake-init because it encapsulates years of CMake expertise into a ready-to-use template, saving time and reducing errors. Its modular design allows customization while enforcing best practices, and it supports the entire development lifecycle out of the box.
Overview
Template for reliable, cross-platform C++ project setup using cmake.
Use Cases
Best For
- Starting a new cross-platform C++ library or application
- Standardizing CMake configurations across a team or organization
- Projects requiring integrated testing with Google Test
- Setting up continuous integration for C++ projects
- Generating project metadata and version headers automatically
- Learning CMake best practices through a well-documented template
Not Ideal For
- Projects that need to combine multiple subprojects into a single CMake super-build
- Developers who prefer a high-level, simplified configuration language over direct CMake syntax
- Very small or experimental projects where the comprehensive development lifecycle support is overkill
- Teams that rely heavily on automatic source file detection via globbing
Pros & Cons
Pros
Explicitly supports Windows, macOS, and GNU/Linux with CMake 3.20+, ensuring consistent builds across major desktop and server environments as stated in the README.
Core, maintainer, and development modules can be included or excluded independently, allowing customization while maintaining a clean project structure.
Includes testing with Google Test, linting, documentation, CI, deployment, and packaging, reducing setup time for full project management.
Avoids file globbing and uses explicit source lists, preventing errors when adding or removing files and adhering to CMake best practices.
Cons
Explicitly listed as a non-goal in the README, making it unsuitable for projects that need to manage multiple interdependent CMake projects as a single build.
Requires familiarity with CMake idioms and best practices, as it avoids high-level abstractions, which can be daunting for beginners despite being a template.
Assumes an external installment of Google Test (e.g., via package managers), which adds setup complexity and may not align with projects using other testing frameworks.
Frequently Asked Questions
Related Projects
cmake-examplesUseful CMake Examples
ModernCppStarter🚀 Kick-start your C++! A template for modern C++ projects using CMake, CI, code coverage, clang-format, reproducible dependency management and much more.
cmake-cookbookCMake Cookbook recipes.
pitchforkPitchfork is a Set of C++ Project Conventions
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.