Skip to content

installation.md

Latest commit

 

History

History
136 lines (94 loc) · 2.59 KB

installation.md

File metadata and controls

136 lines (94 loc) · 2.59 KB
Raw

Building CinderPeak

CinderPeak uses uses Google Test (GTest) for robust unit testing.

The project uses CMake as the primary build system, but alternative build tools like Ninja can also be used seamlessly.

System and Compiler requirements

  • C++17-compatible compiler, GCC 12+, MSVC (with C++17 enabled), or Clang with C++17 support.
  • Build system, CMake (latest stable version recommended) or any compatible C++ toolchain.

Setting Up the Build Directory

Before building, create a separate build directory in the root of the project:

mkdir build
cd build

This keeps all build artifacts cleanly separated from the source code.

Build Configurations

You can customize your build to include examples and/or tests by passing the appropriate flags to CMake.

Build with Tests and Examples

cmake .. -DBUILD_TESTS=ON -DBUILD_EXAMPLES=ON
cmake --build .

This will build everything: core library, tests, and example applications.

Build with Tests Only

cmake .. -DBUILD_TESTS=OFF -DBUILD_EXAMPLES=OFF
cmake --build .

This builds just the example programs—great for trying out features without running tests.

Build with Examples Only

cmake .. -DBUILD_TESTS=OFF -DBUILD_EXAMPLES=ON
cmake --build .

This configuration is ideal for using CinderPeak as a library dependency in other projects.

Build Configurations for Windows

First set up the build directory

mkdir build

Enter the build directory.

cd build

Build options :

  • Using NMake :

    cmake .. -G "NMake Makefiles" -DBUILD_TESTS=ON -DBUILD_EXAMPLES=ON

    To build the files , run:

    nmake

  • Using MinGW :

    cmake .. -G "MinGW Makefiles" -DBUILD_TESTS=ON -DBUILD_EXAMPLES=ON

    To build the files, run:

    mingw32-make

  • Using Visual Studio :

    cmake .. -DBUILD_TESTS=ON -DBUILD_EXAMPLES=ON
cmake --build .

    To build the files, run:

    make -j

Possible errors:

If you encounter :

'nmake'  '-?'
failed with :
no such file or directory

Remove the current build directory

cd ..
rmdir /s build

Recreate the build directory and enter in it.

mkdir build
cd build

Now you can build using another build option.

Output Structure

After building, the compiled binaries can be found in the following directories:

  • Examples: build/bin/examples/
  • Tests: build/bin/tests/

Make sure GTest is correctly installed or discoverable by CMake.