storytold/k4a-sys-temp
2
0
Fork 0
mirror of https://github.com/storytold/k4a-sys-temp.git synced 2026-10-18 07:33:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update cargo.toml and readme

Browse Source
This commit is contained in:
Amédée d'Aboville
2020-01-30 10:45:12 -05:00
parent 6f6a01394d
commit 5e31ede73a
2 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Cargo.toml
+2
View File
@@ -7,6 +7,8 @@ description = "The Azure K4A API bindgen-ed to Rust."
repository = "https://gitlab.com/amedeedabo/k4a-sys" repository = "https://gitlab.com/amedeedabo/k4a-sys"
license = "expat" license = "expat"
gitlab = {repository = "amedeedabo/k4a-sys", branch = "master" } gitlab = {repository = "amedeedabo/k4a-sys", branch = "master" }
documentation = "https://docs.rs/k4a-sys"
keywords = ["kinect"]
[build-dependencies] [build-dependencies]
bindgen = "0.52.0" bindgen = "0.52.0"
README.md
+4 -3
View File
@@ -11,18 +11,20 @@ but it looks time consuming.
Examples Examples
------ ------
I am re-implementing and adding the examples that match the SDK's example in rust. You can run them with eg: There are two examples that match the SDK's. You can run them with eg:
``` ```
cargo run --example enumerate cargo run --example enumerate
cargo run --example streaming
``` ```
Future plans Future plans
------ ------
This is temporarily missing the `depthengine` library, my plan is to statically compile this into the lib soon. 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 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 a niche library, I think it's very convenient to have it statically compiled
into the lib for now. for now.
I'm also planning on writing a safe Rust wrapper library, `k4a-rs` to allow Rust-idiomatic (not raw pointers!) I'm 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 access to the libraries. It will probably live in this repo and we'll move `k4a-sys` to a sub-directory here, the
@@ -31,4 +33,3 @@ same way [`bzip2-rs` and `bzip2-sys`](https://github.com/alexcrichton/bzip2-rs)
I think in the near future we'll remove bindgen from the list of dependencies and only run it every library update, I think in the near future we'll remove bindgen from the list of dependencies and only run it every library update,
that is, by hand/script instead of in the build.rs. This is because bindgen has ~60 dependencies, and should always that is, by hand/script instead of in the build.rs. This is because bindgen has ~60 dependencies, and should always
generate the same output file anyways. (It's possible to make the output cross platform). generate the same output file anyways. (It's possible to make the output cross platform).