Shiny new README.md

Beautify ebuild and add audio USE flag

Signed-off-by: Benn Snyder <benn.snyder@gmail.com>

Author: piedar

OpenNI2-FreenectDriver/README.md

@@ -16,7 +16,7 @@ Install
         cmake .. -DBUILD_OPENNI2_DRIVER=ON
         make
 
-3. Copy the driver to your OpenNI2 driver repository.
+3. Copy the driver to your OpenNI2 driver repository. You must change `Repository` to match your project layout.
 
         Repository="/example/path/to/Samples/Bin/OpenNI2/Drivers/"
         cp -L lib/OpenNI2-FreenectDriver/libFreenectDriver.{so,dylib} ${Repository}
@@ -28,15 +28,25 @@ __________________________________________________
 
 Structure
 ---------
-This driver is modeled on TestDevice.cpp and Drivers/Kinect/. In the FreenectDriver namespace, it ties together the C++ interfaces of OpenNI2 and libfreenect using multiple inheritance.
+This driver is modeled on TestDevice.cpp and Drivers/Kinect/.
+In the FreenectDriver namespace, it ties together the C++ interfaces of OpenNI2 and libfreenect using multiple inheritance.
 
-Driver inherits publically from oni::driver::DriverBase and privately from Freenect::Freenect. A custom libfreenect.hpp allows protected access to the Freenect context, so that FreenectDriver can call the Freenect's C API. As a DriverBase, FreenectDriver manages devices and sets up device state callbacks.
+Driver inherits publically from oni::driver::DriverBase and privately from Freenect::Freenect.
+libfreenect.hpp allows protected access to the Freenect context, so that FreenectDriver can call the Freenect's C API.
+As a DriverBase, FreenectDriver manages devices and sets up device state callbacks.
 
-Device inherits publically from oni::driver::DeviceBase and Freenect::FreenectDevice. Because of this, it can be built by Freenect::Freenect::createDevice() and it can define Device's depth and video callbacks. Those callbacks trigger acquireFrame() in FreenectStream.
+Device inherits publically from oni::driver::DeviceBase and Freenect::FreenectDevice.
+Because of this, it can be built by Freenect::Freenect::createDevice() and it can define Device's depth and video callbacks.
+Those callbacks trigger acquireFrame() in FreenectStream.
 
-VideoStream is a virtual base class inheriting from oni::driver::StreamBase. It does generic frame setup in buildFrame() and then calls pure virtual populateFrame() to let derived classes finish the frame. It also provides the base skeleton for setting and getting properties, which cascades down the inheritance tree.
+VideoStream is a virtual base class inheriting from oni::driver::StreamBase.
+It does generic frame setup in buildFrame() and then calls pure virtual populateFrame() to let derived classes finish the frame.
+It also provides the base skeleton for setting and getting properties, which cascades down the inheritance tree.
 
-DepthStream and ColorStream are nearly identical in definition and implementation, both inheriting from VideoStream. They differ mostly in the formats they use to process data and the video modes they support. These two classes offer a system to store and report supported video modes. To implement a new mode, simply add it to getSupportedVideoModes() and modify populateFrame() if necessary.
+DepthStream and ColorStream are nearly identical in definition and implementation, both inheriting from VideoStream.
+They differ mostly in the formats they use to process data and the video modes they support.
+These two classes offer a system to store and report supported video modes.
+To implement a new mode, simply add it to getSupportedVideoModes() and modify populateFrame() as necessary.
 
 __________________________________________________
 

README.asciidoc

@@ -0,0 +1,170 @@
+libfreenect
+===========
+
+libfreenect is a userspace driver for the Microsoft Kinect.
+It runs on \*nix, OSX, and Windows and supports
+
+- RGB and Depth Images
+- Motors
+- Accelerometer
+- LED
+
+Audio is a work in progress.
+
+
+# Build Guide
+
+To build libfreenect, you'll need
+
+- [libusb](http://libusb.info/) >= 1.0.13
+- [CMake](http://www.cmake.org/) >= 2.6
+
+For the examples, you'll need
+
+- OpenGL   (included with OSX)
+- glut     (included with OSX)
+- [pthreads-win32](http://sourceforge.net/projects/pthreads4w/) (Windows)
+
+## Fetch & Build
+
+    git clone https://github.com/OpenKinect/libfreenect
+    cd libfreenect
+    mkdir build
+    cd build
+    cmake ..
+    cmake --build . 
+
+## OSX
+
+If you don't have a package manager, install [Homebrew](http://brew.sh/).
+For a manual build, see [the wiki](http://openkinect.org/wiki/Getting_Started#Manual_Build_under_OSX).
+
+### Homebrew
+
+    brew install libfreenect
+    # or get the very latest:
+    # brew install --HEAD libfreenect
+    
+### MacPorts
+
+    sudo port install git-core cmake libusb libtool
+    # GOTO: Fetch & Build
+
+## Linux
+
+For a manual build, see [the wiki](http://openkinect.org/wiki/Getting_Started#Manual_Build_on_Linux).
+
+### Ubuntu/Debian/Mint
+
+The version packaged in Ubuntu may be very old.
+To install newer packaged builds, see [the wiki](http://openkinect.org/wiki/Getting_Started#Ubuntu.2FDebian).
+Continue with this section for a manual build.
+
+    sudo apt-get install git-core cmake pkg-config build-essential libusb-1.0-0-dev
+    sudo adduser $USER video
+    sudo adduser $USER plugdev # necessary?
+    
+    # only if you are building the examples:
+    sudo apt-get install libglut3-dev libxmu-dev libxi-dev
+    
+    # GOTO: Fetch & Build
+    
+There is also a [debian branch](https://github.com/OpenKinect/libfreenect/tree/debian) for packaging purposes.
+
+### Gentoo Linux
+
+There is a live ebuild for your convenience in [platform/linux/portage/dev-libs/libfreenect/](https://github.com/OpenKinect/libfreenect/tree/master/platform/linux/portage/dev-libs/libfreenect).
+
+### Arch Linux
+
+There is a [libfreenect-git](https://aur.archlinux.org/packages/libfreenect-git/) PKGBUILD in the AUR.
+
+
+## Windows
+
+The inf files in [platform/windows/](https://github.com/OpenKinect/libfreenect/tree/master/platform/windows) may be used for installing the device.
+Follow **Fetch & Build** or use Github and CMake GUI tools.
+You may need to supply paths to CMake so it can find dependencies.
+For example:
+
+    cmake .. -DLIBUSB_1_INCLUDE_DIR="C:\path\to\libusb\include" -DLIBUSB_1_LIBRARY="C:\path\to\libusb\libusb.lib"
+
+
+# Wrappers
+
+Interfaces to various languages are provided in [wrappers/](https://github.com/OpenKinect/libfreenect/tree/master/wrappers).
+Wrappers are not guaranteed to be API stable or up to date.
+
+- C (using a synchronous API)
+- C++
+- C#
+- python
+- ruby
+- actionscript
+- Java (JNA)
+
+
+# Maintainers
+
+Ongoing Development and Maintenance by the OpenKinect Community
+
+http://www.openkinect.org
+
+- Original Code and Engineering: Hector Martin (marcan)
+- Community Lead: Josh Blake (JoshB)
+- Integration: Kyle Machulis (qDot)
+
+
+# License
+
+The libfreenect project is covered under a dual Apache v2/GPL v2
+license. The licensing criteria are listed below, as well as at the
+top of each source file in the repo.
+
+```
+This file is part of the OpenKinect Project. http://www.openkinect.org
+
+Copyright (c) 2010 individual OpenKinect contributors. See the CONTRIB
+file for details.
+
+This code is licensed to you under the terms of the Apache License,
+version 2.0, or, at your option, the terms of the GNU General Public
+License, version 2.0. See the APACHE20 and GPL2 files for the text of
+the licenses, or the following URLs:
+http://www.apache.org/licenses/LICENSE-2.0
+http://www.gnu.org/licenses/gpl-2.0.txt
+
+If you redistribute this file in source form, modified or unmodified,
+you may: 
+
+- Leave this header intact and distribute it under the same terms,
+  accompanying it with the APACHE20 and GPL2 files, or
+- Delete the Apache 2.0 clause and accompany it with the GPL2 file, or
+- Delete the GPL v2 clause and accompany it with the APACHE20 file 
+
+In all cases you must keep the copyright notice intact and include a
+copy of the CONTRIB file.
+ 
+Binary distributions must follow the binary distribution requirements
+of either License.
+```
+
+
+# More Information
+
+Information about the OpenKinect project can be found at
+
+http://www.openkinect.org
+
+For questions, support, and discussion, check out the google groups
+mailing list at
+
+http://groups.google.com/group/openkinect
+
+Or the IRC channel at
+
+\#openkinect on Freenode
+
+We are also on twitter at
+
+http://twitter.com/openkinect

README.md

@@ -1 +1 @@
-EBUILD libfreenect-9999.ebuild 1926 SHA256 ce96381a0574be42ab0c50e06c647ef0db7a9fe8ed8a9ebf55c9013fb20f8e5f SHA512 ef692429fe0a746a42e3fb4ef39ead0da258ddf418cbb839d9bb4617aa6607490cc2578505a88d1cc5bc01ac90fabcb9d9a27a000f7ab6533a1fb2f75610c2a6 WHIRLPOOL 50bc5c4de88c28df3d94cc2b9bc9f90120ed029f2af43c585c54e0c9ce7b9f96893c74fe6a06f7145a081bbb4ad7893fec940218aa1ddd7dd34d895bd41ef5f5
+EBUILD libfreenect-9999.ebuild 2246 SHA256 9c108418122975f5c9f6587e9c7e35625ce4cc47932b2c0b03b22ccb802d39da SHA512 05310b350b6598fd826c6ca6e12edc1f809157924a6fac93cb01ee8652b1d544144a22f32fe6ecf8ebd476e73c2a3c334aed02342d2e060ab6cdf88ef4ec965f WHIRLPOOL e9676dbe32df58e78c66343a0f665217b5b89b08f2caf777090536757024e57478694abe04a6cb290a6aef9e5ed46964b83d64ab55c7187f77fbf54150b83fed