Ruckig is by default written in C++17 and has no dependencies (except for testing) besides the C++ standard library. Builds are validated on major operating systems using the three compilers gcc, clang, and msvc.

C++

To build Ruckig using CMake, run the usual commands

mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release  ..
make

In general, we recommend enabling link time optimization via -DCMAKE_INTERPROCEDURAL_OPTIMIZATION=ON.

To install Ruckig in a system-wide directory, you can either use

(sudo) make install or
install it as a Debian package via cpack && sudo dpkg -i ruckig*.deb.

Using in CMake Projects

We recommend one of the following approaches in your parent CMakeLists.txt:

# 1. Find the system-wide installed Ruckig
find_package(ruckig REQUIRED)
 
# 2. Copy Ruckig into your project and call
add_subdirectory(ruckig)
 
target_link_libraries(example PRIVATE ruckig::ruckig)

Older C++ Versions

C++11 and C++03 versions of Ruckig Pro are also available - please contact us if you're interested. While the C++11 version depends (as the standard Ruckig version) only on the C++ standard library, the C++03 requires polyfills of the Boost library. Internally we test against Boost v1.58, though older (e.g. v1.42) and newer versions should also work.

Python

Ruckig is also available as a Python module wrapping the C++ core, supporting Python 3.9 or later. As Python is inherently not real-time capable, we recommend it primarily for development and debugging purposes. From the project directory, build and install with:

pip install .

The Ruckig Community Version can be installed from PyPI via

pip install ruckig

Rust

A beta version of the Rust wrapper is available for the Community version on crates.io.

	Next
	Tutorial