From 75eb97bbef407207f47d0a8ad5324f620f32a4ed Mon Sep 17 00:00:00 2001 From: Brandon Thomas Date: Sun, 17 Jan 2021 16:58:05 -0500 Subject: [PATCH] Update Cargo.toml and README to reflect that this is a fork --- Cargo.toml | 12 ++++++------ README.md | 12 ++++++++++++ 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 9beaaca..e67f0e4 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,13 +1,13 @@ [package] -name = "k4a-sys" +name = "k4a-sys-temp" version = "0.2.1" -authors = ["Amédée d'Aboville "] +authors = ["fork of Amedee's code"] edition = "2018" -description = "The Azure K4A API bindgen-ed to Rust." -repository = "https://gitlab.com/amedeedabo/k4a-sys" +description = "A patched version of k4a-sys that builds on Linux. This will be deprecated when k4a-sys is bumped." +repository = "https://github.com/storytold/k4a-sys-temp" license = "MIT" -gitlab = {repository = "amedeedabo/k4a-sys", branch = "master" } -documentation = "https://docs.rs/k4a-sys" +github = {repository = "storytold/k4a-sys-temp", branch = "master" } +documentation = "https://docs.rs/k4a-sys-temp" keywords = ["kinect"] [build-dependencies] diff --git a/README.md b/README.md index c979c9a..2de635c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ +# NOTE: This fork is a hack. Do not use. + +This has been forked from [Amedee's upstream k4a-sys](https://gitlab.com/amedeedabo/k4a-sys) to enable my work +on Linux. If I were a better open source citizen, I'd reach out directly and help get a patched version uploaded +to the crates registry, but I'm juggling too many things. (Sorry!) + +If `k4a-sys` gets pushed beyond version `0.2.0`, I'll deprecate and yank this crate. + +The only thing of note being done here is changing the `build.rs` to reference the correct target. Amedee's main +branch already has a fix, but I'm uploading my fork since I have multiple projects that depend on it in its current +state. + k4a-sys ------- A bingden wrapper for the Azure Kinect Sensor SDK, which should work on both Linux and Windows.