Skip to content
/ cmake-project Public template

Template repository for building a cross-platform CMake Project, with some personal formatting configruations

Notifications You must be signed in to change notification settings

Vafdaf12/cmake-project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CMake Project Template

This template is a starting point for a CMake-based project, including some formatting rules that are customized to my coding style

Project Structure

This project follows the Pitchfork Layout for C++ projects. Specifically:

  • src: Source files and the private headers.
  • build: Build artifacts. (Not part of the repo.)
  • data: Non-source files, like INI files.
  • docs: Documentation.
  • examples: Samples and the examples.
  • external: Used external projects.
  • extras: Submodules not build by default.
  • include: Public headers.
  • libs: Submodules build by default.
  • tests: Tests cases.
  • tools: Development utilities.

This allows easy integration with CMake using add_subdirectory, also allowing conditionally builds like not building the test suite

Usage

To use the project, simply clone the repository and configure the following:

  • CMakeLists.txt - change the name of the project to your project name
  • .vscode/launch.json - change the name of the project to your project name

About

Template repository for building a cross-platform CMake Project, with some personal formatting configruations

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published