Skip to content

rustecal-sys/README.md added #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rex-schilasky merged 1 commit into from
May 24, 2025
Merged

rustecal-sys/README.md added #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions rustecal-sys/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# rustecal-sys

Low-level FFI bindings for the [eCAL](https://github.com/eclipse-ecal/ecal) C++ library, enabling Rust code to interface directly with eCAL’s core functionality.

---

## Features

- **Rust FFI**: Safe Rust wrappers live in higher-level crates (`rustecal-core`), while `rustecal-sys` provides the raw `extern "C"` declarations.
- **Cross-platform**: Supports Linux, Windows, and macOS (provided the eCAL C/C++ library is installed for your platform).
- **Build script**: Auto-detects eCAL installations.

## Requirements

- **Rust** 1.60 or later
- **eCAL** C/C++ library v6.0 or later installed and accessible on your system