diff --git a/README.md b/README.md index 7c4e394..2eb9290 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ k4a-sys ------- -A Bingden Wrapper for the Azure Kinect Sensor SDK. +A Bingden Wrapper for the Azure Kinect Sensor SDK, which works on both Linux and Windows. -Builds on both Linux and Windows. Vendors the SDK at version 1.3. +Uses a vendored version of the precompiled SDK at 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 @@ -10,3 +10,9 @@ and added the `include`s and dynamic libraries by hand to the It might be possible to compile libk4a from source in the future, but it looks time consuming at the moment. + +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 +into the lib for now.