Install from the source
Code source of KUMI is available on GitHub and can be retrieved via the following command:
Once retrieved, you should have a kumi folder which contains the whole source code.
Create a build directory here and enter it. Once in the build directory, you can use CMake to generate the build system for KUMI. We recommend using Ninja but any build system is fine.
$ mkdir build
$ cd build
$ cmake .. -G Ninja
Once CMake completes, you can use the install target to build and install KUMI. By default, the library will be installed in the /usr/local directory, thus requiring root privileges.
You can select an alternative installation path by specifying the CMAKE_INSTALL_PREFIX option at configuration time.
$ cmake .. -G Ninja -DCMAKE_INSTALL_PREFIX=path/to/install
$ ninja install
Once installed, KUMI is usable directly by providing the path to its installed files.
Standalone setup
You can also use KUMI via a single standalone file that can be vendored in your own project without having to deal with KUMI as a dependency.
Simply use wget to fetch the latest version and place it where you want:
Use KUMI by just compiling your code with the include path pointing to the location of this single file.
CMake FetchContent
You can also use CMake FetchContent operation and use the kumi::kumi library target that our CMake exports.
##==================================================================================================
## Your project setup
##==================================================================================================
cmake_minimum_required(VERSION 3.22)
project(kumi-fetch LANGUAGES CXX)
include(FetchContent)
FetchContent_Declare(kumi GIT_REPOSITORY "https://github.com/jfalcou/kumi.git" GIT_TAG main)
FetchContent_MakeAvailable(kumi)
add_executable(test_kumi ../main.cpp)
target_link_libraries(test_kumi PUBLIC kumi::kumi)
Setup with CPM
The KUMI library can be setup using CPM:
##==================================================================================================
## Your project setup
##==================================================================================================
cmake_minimum_required(VERSION 3.18)
project(kumi-cpm LANGUAGES CXX)
# Setup CPM - See https://github.com/cpm-cmake/CPM.cmake#adding-cpm
include(cpm.cmake)
CPMAddPackage ( NAME kumi
GIT_REPOSITORY "https://github.com/jfalcou/kumi.git"
OPTIONS "KUMI_BUILD_TEST OFF"
)
add_executable(test_kumi ../main.cpp)
target_link_libraries(test_kumi PUBLIC kumi::kumi)
