Skip to content

Initial Release - Version 1.0

Latest

Choose a tag to compare

@msaeedsaeedi msaeedsaeedi released this 26 Jun 19:35

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.txt for easy project setup and configuration.
    • Separate CMakeLists.txt for tests to keep the build process organized.
  • Custom Styling:

    • Integrated .clang-format file to ensure consistent code styling across the project.
  • Editor Configuration:

    • .editorconfig file 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 .gitignore file to exclude common build and dependency files from version control.

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!