Installation

This guide provides recommended ways to consume kakuhen in CMake projects.

Requirements

• CMake: 3.18 or newer.

• C++ compiler: C++20 capable (GCC 10+, Clang 10+, MSVC 2019+).

• Git: For cloning the repository.

Option A: Add as subdirectory

This is the simplest way to consume a header-only library during development.

1. Vendor or add a submodule, for example:

   git submodule add https://github.com/aykhuss/kakuhen.git external/kakuhen
   

2. Add to your build:

   add_subdirectory(external/kakuhen)
   target_link_libraries(my_app PRIVATE kakuhen::kakuhen)
   

Option B: Install + find_package

1. Clone and configure:

   git clone https://github.com/aykhuss/kakuhen.git
   cd kakuhen
   cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
   

2. Build and install:

   cmake --build build
   cmake --install build
   

   On Windows (multi-config generators), specify the configuration:

   cmake --build build --config Release
   cmake --install build --config Release
   

3. Use in your project:

   find_package(kakuhen CONFIG REQUIRED)
   target_link_libraries(my_app PRIVATE kakuhen::kakuhen)
   

   If CMake cannot find the package, set one of:

   • CMAKE_PREFIX_PATH to the install prefix

   • kakuhen_DIR to the package config directory

Build options

Useful CMake options:

• KAKUHEN_BUILD_TESTING: Build tests.

• KAKUHEN_BUILD_CLI: Build the CLI tool.

• KAKUHEN_BUILD_EXAMPLES: Build examples.

• KAKUHEN_BUILD_DOCS: Build documentation.

• KAKUHEN_ENABLE_COVERAGE: Enable coverage (GCC/Clang only).