Skip to content
/ CMake Public
forked from Jamagas/CMake

C++ project structure with Google Test (gtest) example using CMake as build system.

License

Notifications You must be signed in to change notification settings

Peilix/CMake

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CMake example

This repository is CMake project structure example originally created for XCode project generation. But it contains valuable insights how to structure your code that it would be easy to maintain using CMake.

Table of contents

Project structure

Project structure is basically one master project with two static libraries.

Insight is that Foo is some kind of project you are working on and deliver as a product. This Foo product depends on two static libraries A and B which is stand alone libraries without external dependencies.

Foo
 ├── CMakeLists.txt
 ├── README.md
 ├── include
 ├── libs
 │   ├── A
 │   │   ├── CMakeLists.txt
 │   │   ├── include
 │   │   │   └── A
 │   │   │       └── A.h
 │   │   ├── src
 │   │   │   └── A.cpp
 │   │   └── test
 │   │       ├── ATests.cpp
 │   │       └── CMakeLists.txt
 │   ├── B
 │   │   ├── CMakeLists.txt
 │   │   ├── include
 │   │   │   └── B
 │   │   │       └── B.h
 │   │   ├── src
 │   │   │   └── B.cpp
 │   │   └── test
 │   │       ├── BTests.cpp
 │   │       └── CMakeLists.txt
 │   └── gtest-1.7.0
 ├── src
 │   └── main.cpp
 └── test

Running CMake

To run CMake you need to go into Foo directory and do these steps:

  1. Create build directory mkdir build.
  2. Go into created build directory cd build.
  3. Run CMake to create XCode project cmake -G Xcode ../, but you can create any other project you want.
  4. Open XCode project open Foo.xcodeproj.

NOTE: DO NOT make changes to generated project file, instead edit CMakeLists.txt files and regenerate project using CMake. For example, when you want to add files to project you update CMakeLists.txt to include those files and regenerate build system using CMake.

Copyright and license

Code and documentation copyright 2015 Darius Sabaliauskas and released under the MIT license.

About

C++ project structure with Google Test (gtest) example using CMake as build system.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 85.0%
  • Shell 9.2%
  • Python 5.1%
  • Other 0.7%