Skip to content

BUILD.md

Latest commit

 

History

History
55 lines (36 loc) · 1.32 KB

BUILD.md

File metadata and controls

55 lines (36 loc) · 1.32 KB
Raw

CereLink Build Instructions

Pre-built packages are available on the releases page.

For GitHub Actions build scripts, see .github/workflows/.

Requirements

C++17 toolchain and CMake 3.16+.

Build

cmake -B build -S . -DCMAKE_BUILD_TYPE=Release
cmake --build build --config Release -j

CMake Options

Option Default Description
CBSDK_BUILD_TEST ON (standalone) Build unit and integration tests
CBSDK_BUILD_SAMPLE ON (standalone) Build example applications
CBSDK_BUILD_SHARED OFF Build cbsdk_shared (DLL/dylib/so) for pycbsdk

Run Tests

ctest --test-dir build --build-config Release --output-on-failure -E "^device\."

The -E "^device\." filter excludes tests that require a physical device or network.

Build Shared Library (for pycbsdk)

cmake -B build -S . -DCBSDK_BUILD_SHARED=ON -DCBSDK_BUILD_TEST=OFF -DCMAKE_BUILD_TYPE=Release
cmake --build build --target cbsdk_shared --config Release

Install

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

Package

cmake --build build --target package --config Release

Python (pycbsdk)

See pycbsdk/ for building the Python wheel from source.