Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 1.69 KB

install.md

File metadata and controls

71 lines (51 loc) · 1.69 KB
Raw

Install

Prerequisites

Linux

Install GCC/Clang, CMake, make/ninja/etc.

macOS

Install xcode, CMake.

Windows

Install MSVC.

As library

CMake with FetchContent

include(FetchContent)
FetchContent_Declare(yaclib
  GIT_REPOSITORY https://github.com/YACLib/YACLib.git
  GIT_TAG main
  )
FetchContent_MakeAvailable(yaclib)

As project for develop

Console install and CMake/build options

  1. git clone <repo-url>
  2. In the build directory:
cmake <source-dir> <cmake-options>

CMake options:

  • -G <generator-name> (more info).
  • -D CMAKE_BUILD_TYPE=<build-type> (more info).
  • -D CMAKE_CXX_COMPILER=<cxx-compiler-path> Path to your C++ compiler.
  • -D YACLIB_BUILD_TEST=<OFF(default) or ON or SINGLE> If ON, then build tests, if SINGLE, then make one test target
  • -D YACLIB_FLAGS=<EMPTY(default) or WARN or ASAN or TSAN or UBSAN or LSAN or MEMSAN or COVERAGE or CORO or DISABLE_FUTEX or DISABLE_UNSAFE_FUTEX or DISABLE_SYMMETRIC_TRANSFER or DISABLE_FINAL_SUSPEND_TRANSFER> Any of the specified flags will enable/disable the respective build property or functionality.
  • -D YACLIB_FAULT=<OFF(default) or THREAD or FIBER> Using THREAD will provide fault-injection functionality and using FIBER will execute all operations in a single-threaded cooperative fiber scheduler.
cmake --build . -- <build-options>

Example

In POSIX-compliant shell:

git clone git@github.com:YACLib/YACLib.git
cd YACLib
cmake -S . -B ./build -GNinja -DYACLIB_TEST=ON
cmake --build ./build --parallel