Repository navigation
Release Notes - Version 1.0
We are excited to announce the first release of the C++ CMake Project Template! This initial version provides a solid foundation for creating C++ projects with CMake, custom code styling, and integrated unit testing with GTest. Below are the key features and details of this release.
Key Features
-
CMake Support:
- Main
CMakeLists.txtfor easy project setup and configuration. - Separate
CMakeLists.txtfor tests to keep the build process organized.
- Main
-
Custom Styling:
- Integrated
.clang-formatfile to ensure consistent code styling across the project.
- Integrated
-
Editor Configuration:
.editorconfigfile to maintain consistent editor settings for all contributors.
-
Unit Testing:
- Integrated Google Test (GTest) framework for writing and running unit tests.
- Example test cases to help you get started quickly.
-
.gitignore:
- Pre-configured
.gitignorefile to exclude common build and dependency files from version control.
- Pre-configured
Project Structure
cmake-project-template/
├── .clang-format # Custom styling configuration
├── .editorconfig # Editor configuration
├── .gitignore # Git ignore file
├── CMakeLists.txt # Main CMake configuration file
├── src/
│ └── main.cpp # Main source file
└── test/
├── CMakeLists.txt # CMake configuration file for tests
├── test_main.cpp # Main test file
└── src/
└── temp_test.cpp # Example test file
Getting Started
To get started with this project template, please follow the instructions in the README.md file.
Contributions
We welcome contributions! If you have suggestions for improvements or new features, please open an issue or submit a pull request.
Acknowledgments
Thank you for using our C++ CMake Project Template. We look forward to your feedback and contributions!