libcsp-rust/libcsp/README.md
2024-06-01 12:20:07 +02:00

1.1 KiB

libcsp-rust

This crate provides a (mostly) safe and ergonomic Rust API for the libcsp library on top of the libcsp-sys crate. You can find some more high-level information and examples in the main repository.

The API documentation should provide all additional information required to use this library.

Compile-time configuration of the libcsp-rust library

The libcsp-rust library requires some compile-time configuration file to be included to work properly. You can see an example version of the file for the workspace here. The user has to provide the path to a directory containing this autoconfig.rs file using the CSP_CONFIG_DIR environmental variable.

It is recommended to read the main workspace README for more information to make the generation and specification of this auto-configuration file as conveniently and easy as possible.