thiago-rezende / cmake-starter-project Goto Github PK

View Code? Open in Web Editor NEW

C++ Starter Project Using CMake

License: MIT License

CMake 32.61% C++ 51.80% Shell 4.91% C 10.68%

cmake-starter-project's Introduction

C++ Starter Project Using CMake

CMake Starter Project

A Simple C++ Starter Project Using CMake
Report Bug · Request Feature . Continuous Integration

Libraries Included
- Spdlog
- Catch2
Features
- Full featured logger
- Assertion utilities compatible with the logger
- Instrumentation for profiling [compatible with chromium tracing]
- Platform detection utilities
- Documentation generation with Doxygen
- Unit testing with Catch2 and CTest
- CI with GitHub Actions
- Pre-compiled headers to improve build times
Project structure

   .
   ├── .github                         # Repository stuff.
   ├── application                     # Application folder.
   |    ├── assets                     # Assets folder.
   |    ├── core                       # Core functionalities folder.
   |    |    ├── logger.h              # Logger utils.
   |    |    ├── logger.cpp            # Logger utils implementation.
   |    |    └── platform_detection.h  # Platform detection macros.
   |    ├── debug                      # Debug functionalities folder.
   |    |    ├── assert.h              # Assertion utils.
   |    |    └── instrumentor.h        # Profiling utils.
   |    ├── pch.hpp                    # Pre-compiled header.
   |    ├── config.h                   # Populated at config time.
   |    ├── config.h.in                # Template for config.h.
   |    ├── main.cpp                   # Application entrypoint.
   |    └── CMakeLists.txt             # Application CMake build script.
   ├── tests                           # Tests folder.
   |    ├── application                # Application tests.
   |    |    ├── CMakeLists.txt        # Application tests CMake script.
   |    |    └── never_fails.cpp       # Application test file.
   |    └── CMakeLists.txt             # Main CMake tests script.
   ├── vendor                          # Third-party packages will be here.
   |    ├── spdlog                     # Fast C++ logging library.
   |    └── catch2                     # A modern, C++-native, header-only, test framework.
   └── CMakeLists.txt                  # Main CMake build script.