Skip to content

Commit

Permalink
improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
marshally committed Jun 21, 2012
1 parent 3a83591 commit b30d733
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,38 @@ To bring Unix-y goodness to the world of Microsoft Kinect programming!

Because Kinect programming is a pain in the neck, and by trivializing the device's output into a simple text format, it becomes infinitely easier to digest in the scripting language of your choice.

### This seems simple to the point of being almost useless

Yes, that's the point. Do One Thing and Do It Well. There's an accompanying rubygem that will add all the smart stuff like advanced gesture recognition, events, etc.

## USAGE

% kinectable_pipe -r 30
% kinectable_pipe | ruby some_other_script.rb

## INSTALLATION (OS X / homebrew)

# must have universal binary for libusb
brew uninstall libusb
brew install libusb --universal

brew tap marshally/alt

brew install kinectable_pipe

# now plug in your kinect
# and run this command in the terminal

kinectable_pipe

# step back from the sensor, wave your arms like a lunatic
# until it recognizes you and starts pumping out skeleton data
# to STDOUT

## TODO

1. Recognize all available `xn::GestureGenerator`
1. Fix output to work with non-interactive terminal sessions.
1. Add CLI argument `-r` to change output framerate.
1. Improve Ruby sample app.
1. Add sample apps for other scripting languages.
1. Add CLI argument for alternate output encodings (XML, msgpack, BERT, whatever).

0 comments on commit b30d733

Please sign in to comment.