Skip to content

building.md

Latest commit

 

History

History
68 lines (53 loc) · 2.06 KB

building.md

File metadata and controls

68 lines (53 loc) · 2.06 KB

Binary bakery - Building from source

===========================

This document has instructions on how to build Binary bakery 🍪 from source. binary_bakery_CI

Note that it only covers the build of library itself and is mostly meant for contributors and/or power users. Other should follow the user instructions. See the Readme for instructions.

Quick jump

Our CI handles most of the cases and steps are available through cmake. Your mileage may vary.

cmake -B build -S . -DBUILD_VCPKG=ON
cmake --build build --config Release --target install
ctest --test-dir build -C Release --output-on-failure

If you would like to set the dependencies manually, continue below.

Pre-requisites

Recommended way to install the dependencies is using vcpkg.

Quick start on Windows:

git clone https://github.com/microsoft/vcpkg build/vcpkg
.\build\vcpkg\bootstrap-vcpkg.bat
.\build\vcpkg\vcpkg install zstd lz4 tomlplusplus fmt stb doctest --triplet=x64-windows-static

Ubuntu

git clone https://github.com/microsoft/vcpkg build/vcpkg
./build/vcpkg/bootstrap-vcpkg.sh
./build/vcpkg/vcpkg install zstd lz4 tomlplusplus fmt stb doctest --triplet=x64-linux

Configure & Build

Configuration step will require the path to vcpkg. Windows

cmake -B build -S . -DCMAKE_TOOLCHAIN_FILE=%cd%/build/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows-static -DCMAKE_INSTALL_PREFIX=install

Ubuntu

cmake -B build -S . -DCMAKE_TOOLCHAIN_FILE=vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-linux -DCMAKE_INSTALL_PREFIX=install

Compile all

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

Run the tests Windows

.\build\tests\Release\tests.exe

Ubuntu

./build/tests/tests

Contribute

  • Install scripts
  • CI/CD
  • CMake functions to automate resource file generation