Skip to content

Commit

Permalink
Minor updates in README
Browse files Browse the repository at this point in the history
  • Loading branch information
bibigone committed Aug 2, 2019
1 parent 0044daf commit 65fe5be
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
using System.Windows;

[assembly: AssemblyTitle("K4AdotNet.Samples.Wpf.BodyTracker")]
[assembly: AssemblyDescription("WPF sample application to demonstrate using of Body Tracking API.")]
[assembly: AssemblyDescription("WPF sample application to demonstrate usage of Body Tracking API.")]

[assembly: ComVisible(false)]

Expand Down
2 changes: 1 addition & 1 deletion K4AdotNet.Samples.Wpf.Viewer/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
using System.Windows;

[assembly: AssemblyTitle("K4AdotNet.Samples.Wpf.Viewer")]
[assembly: AssemblyDescription("WPF sample application to demonstrate using of Sensor API and Record API.")]
[assembly: AssemblyDescription("WPF sample application to demonstrate usage of Sensor API and Record API.")]

[assembly: ComVisible(false)]

Expand Down
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
* But currently tested only under Windows
* Plus there's no Linux-version of [Azure Kinect Body Tracking SDK](https://docs.microsoft.com/en-us/azure/Kinect-dk/body-sdk-download) yet
* And most of samples are written using WPF
* Available as NuGet package: https://www.nuget.org/packages/K4AdotNet


## Dependencies
Expand Down Expand Up @@ -63,25 +64,27 @@ Some important notes:
* Also, you can optionally call `bool Sdk.TryInitializeBodyTrackingRuntime(out string message)` method on start of your application to initialize Body Tracking runtime (it can take a few seconds)


## Current status
## Versions

It's almost ready to use
* [v0.5.0](https://github.com/bibigone/k4a.net/releases/tag/v0.5.0) — First public build. Stable enough to be used in pre-production projects.


## Roadmap

* Nuget package(s)
* Documentation comments
* More unit-tests
* More samples (Recording, 3D view, Box-man, IMU...)
* Samples for Unity3D
* Find out how to convert MJPEG -> BGRA faster (implementation in `k4a.dll` is very slow)
* Test under Linux, samples for Linux (using [Avalonia UI Framework](http://avaloniaui.net/)?)
* Some hosting for documentation
* Some hosting for HTML documentation ([DocFX](https://dotnet.github.io/docfx/) + [github.io](https://pages.github.com/)?)


## How to build

* Open `K4AdotNet.sln` in Visual Studio 2017 or Visual Studio 2019
* Build solution (`Ctrl+Shift+B`)
* After that you can run and explore samples
* After that you can run and explore samples:
* `K4AdotNet.Samples.BodyTrackingSpeedTest` — Core .NET sample console application to measure speed of Body Tracking.
* `K4AdotNet.Samples.Wpf.Viewer` — WPF sample application to demonstrate usage of Sensor API and Record API.
* `K4AdotNet.Samples.Wpf.BodyTracker` — WPF sample application to demonstrate usage of Body Tracking API.

0 comments on commit 65fe5be

Please sign in to comment.