cpp-project-template

This is a starting template for C++ projects that supports:

• Hierarchical sources and headers
• Access to Google Tests
• Use of CMake for much easier compiling
• Code documentation with Doxygen
• Continuous testing with Travis-CI
• Code coverage with Coveralls.io
• Static analysis with Coverity Sacn

Structure

.
├── CMakeLists.txt
├── app
│   └── main.cpp
├── include
│   ├── example.h
│   └── exampleConfig.h.in
├── src
│   └── example.cpp
└── tests
    ├── dummy.cpp
    └── main.cpp

Sources go in src/, header files in include/, main programs in app/, and tests go in tests/ (compiled to unit_tests.x by default).

If you add a new executable, say app/hello.cpp, you only need to add the following three lines to CMakeLists.txt:

add_executable(hello.x app/hello.cpp)   # Name of exec. and location of file.
add_dependencies(hello.x engine)        # engine is the library built from src/*.cpp
target_link_libraries(hello.x engine)   # Link the executable to the 'engine'.

You can find the example that builds the example in app/main.cpp under the Build section in CMakeLists.txt. If the executable you made does not use the library in src/, then only the first line is needed.

Building

Build by making a build directory (i.e. build/), run cmake in that dir, and then use make to build the desired target.

Example:

$ mkdir build && cd build
$ cmake .. # argument is location of CMakelists.txt
$ make
$ make gtest
$ ./main.x

.gitignore

The .gitignore file is a copy of the Github C++.gitignore file, with the addition of ignoring the build directory (build/).

Services

If repository is activated with Travis-CI, then unit tests will be built and executed on each commit.

If repository is activated with Coveralls, then deployment to Travis will also calculate code coverage and upload this to Coveralls.io.

If repository is activated with Coverity-Scan, then source commited will be uploaded to Coverity Scan for static analysis.

Acknowledgement

This template is extended based on cpp-project.