From b6105ed47b806b89569174c17ca7604b4d4c83d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Am=C3=A9d=C3=A9e=20d=27Aboville?= Date: Thu, 20 Feb 2020 15:24:55 -0500 Subject: [PATCH] Update Readme and add changelog. --- CHANGELOG.md | 19 +++++++++++++++++++ README.md | 21 ++++++++++----------- 2 files changed, 29 insertions(+), 11 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..da7aea7 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,19 @@ +# Changelog +All notable changes to this project will be documented in this file. + + +## [0.2.1] - 2020-02-20 +### Removed + +- Vendored `.so`s as they are actually not used in the build. + +## [0.2.0] - 2020-02-05 +### Added + +- Initial linux bindings to `libk4a` version 1.3. + +## [0.1.0] - 2020-02-05 + +### Added + +- Initial windows bindings to `libk4a` version 1.3. diff --git a/README.md b/README.md index e768be1..c979c9a 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ k4a-sys ------- -A bingden wrapper for the Azure Kinect Sensor SDK, which works on both Linux and Windows. +A bingden wrapper for the Azure Kinect Sensor SDK, which should work on both Linux and Windows. Vendors the compiled SDK libs from version 1.3. -At the moment I have compiled the sdk on both Linux and Windows -and added the `include`s and dynamic libraries by hand to the -`vendor` folder. It might be possible to compile libk4a from source in the future, +On linux you need to install `libk4a1.3` to be able to use `libk4a.so` and `libdepthengine.so`. + +On windows you need to install the Sensor SDK to able to have the `libdepthengine.dll`. + +One future wish is to statically compile the SDK into this library, which would require modifying +the SDK's build to output a static library we could link against. + +It also might be possible to compile libk4a from source in the future, but it looks time consuming. Examples @@ -20,13 +25,7 @@ cargo run --example streaming Future plans ------ -This is temporarily missing the `depthengine` library, my plan is to statically compile this into the lib soon. - -Raise an issue if you'd like dynamic linking, but since `k4a` is such -a niche library, I think it's very convenient to have it statically compiled -for now. - -I'm also planning on writing a safe Rust wrapper library, `k4a-rs` to allow Rust-idiomatic (not raw pointers!) +I've started also planning on writing a safe Rust wrapper library, `k4a-rs` to allow Rust-idiomatic (not raw pointers!) access to the libraries. It will probably live in this repo and we'll move `k4a-sys` to a sub-directory here, the same way [`bzip2-rs` and `bzip2-sys`](https://github.com/alexcrichton/bzip2-rs) work.