Update Cargo.toml and README to reflect that this is a fork

This commit is contained in:
Brandon Thomas
2021-01-17 16:58:05 -05:00
parent 0a4fe307b4
commit 75eb97bbef
2 changed files with 18 additions and 6 deletions
+6 -6
View File
@@ -1,13 +1,13 @@
[package]
name = "k4a-sys"
name = "k4a-sys-temp"
version = "0.2.1"
authors = ["Amédée d'Aboville <amedee.daboville@gmail.com>"]
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]
+12
View File
@@ -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.