Skip to content

Files

Latest commit

 

History

History
48 lines (30 loc) · 1.47 KB

README.md

File metadata and controls

48 lines (30 loc) · 1.47 KB

Crates.io License

ClockBound Foreign Function Interface (FFI)

This crate implements the FFI for ClockBound. It builds into the libclockbound c library that an application can use to communicate with the ClockBound daemon.

Usage

clock-bound-ffi requires ClockBound daemon to be running to work. See ClockBound daemon documentation for installation instructions.

Building

Run the following to build the source code of this crate:

cargo build --release

It produces libclockbound.a, libclockbound.so

  • Copy clock-bound-ffi/include/clockbound.h to /usr/include/
  • Copy target/release/libclockbound.a to /usr/lib/
  • Copy target/release/libclockbound.so to /usr/lib/

Example

Source code of a runnable c example program can be found at ../examples/c. See the README.md in that directory for more details on how to build and run the example.

Updating README

This README is generated via cargo-readme. Updating can be done by running:

cargo readme > README.md

Security

See CONTRIBUTING for more information.

License

Licensed under the Apache 2.0 license.