README.md

Skeleton

Skeleton is a C++ project skeleton written in C++14.

Prerequisites

The project is built using CMake and requires version 3.20 or newer to work correctly.

Skeleton takes a dependency on googletest for unit tests and is included in the source tree as a git submodule. Run the following to check out the module and make it available to the build system:

$ cd <path-to-skeleton>
$ git submodule update --init

Building

Skeleton is tested on Linux and macOS.

The following will generate the build system and then build all targets:

$ cd <path-to-skeleton>
$ cmake -B build
$ cmake --build build

Tests

Start by building the unit tests executable:

$ cmake --build build --target skeleton-tests

Now run the unit tests using CMake's ctest utility:

$ ctest --test-dir build -R unit-tests -V

Alternatively, run the tests executable directly:

$ ./build/skeleton-tests