few preparations to publish first crates (rustecal-sys and rustecal-c…

README.md

@@ -14,6 +14,18 @@ Rust bindings for the high-performance [eCAL](https://github.com/eclipse-ecal/ec
 
 ---
 
+## System Requirements
+
+This crate requires a native installation of the [Eclipse eCAL](https://github.com/eclipse-ecal/ecal) C/C++ runtime, version 6.0 or newer. General instruction for the installation you can find [here](https://eclipse-ecal.github.io/ecal/stable/getting_started/setup.html).
+
+On Linux:
+- Make sure `libecal.so` and headers are available in your system paths.
+
+On Windows:
+- Set the `ECAL_HOME` environment variable to the root of your eCAL installation.
+
+This crate will fail to compile if the native libraries are not found.
+
 ## Examples
 
 ### Publisher

rustecal-core/Cargo.toml

@@ -1,8 +1,14 @@
 [package]
 name = "rustecal-core"
 version = "0.1.0"
+authors = ["Rex Schilasky"]
 edition = "2021"
-publish = false
+description = "Idiomatic Rust API for Eclipse eCAL"
+license = "Apache-2.0"
+repository = "https://github.com/eclipse-ecal/rustecal"
+readme = "README.md"
+keywords = ["ecal", "ipc", "pubsub", "server-client", "middleware"]
+categories = ["network-programming", "api-bindings"]
 
 [dependencies]
 rustecal-sys = { path = "../rustecal-sys" }

rustecal-sys/Cargo.toml

@@ -1,10 +1,15 @@
 [package]
 name = "rustecal-sys"
 version = "0.1.0"
+authors = ["Rex Schilasky"]
 edition = "2021"
 build = "build.rs"
 description = "Raw FFI bindings to Eclipse eCAL C API"
 license = "Apache-2.0"
+repository = "https://github.com/eclipse-ecal/rustecal"
+readme = "README.md"
+keywords = ["ecal", "ipc", "pubsub", "server-client", "middleware"]
+categories = ["network-programming", "api-bindings"]
 
 [build-dependencies]
 bindgen = "0.71.0"