NEWS: release v0.5

[kinect-audio-setup.git] / README

diff --git a/README b/README
index 306e480..fb0d057 100644 (file)
--- a/README
+++ b/README
@@ -1,15 +1,15 @@
 kinect-audio-setup makes audio input from the Microsoft Kinect Sensor
 device work on GNU/Linux systems.
 
 kinect-audio-setup makes audio input from the Microsoft Kinect Sensor
 device work on GNU/Linux systems.
 

-When the Kinect is first plugged in the USB port it shows up as a
-generic USB device with a bulk endpoint; after uploading a certain
+When the Kinect is first plugged in the USB port it shows up as
+a generic USB device with a bulk endpoint; after uploading a certain

 firmware a reenumeration takes place and a USB Audio Class (UAC) device
 becomes available.
 
 kinect-audio-setup provides tools to download the firmware off the net
 firmware a reenumeration takes place and a USB Audio Class (UAC) device
 becomes available.
 
 kinect-audio-setup provides tools to download the firmware off the net

-at installation time —since it is not redistributable—, and it sets up
-udev rules to call the firmware loader when the device is plugged in to
-finally get the USB Audio Class device.
+at installation time —since the firmware is not redistributable—, and it
+sets up udev rules to call the firmware loader when the device is
+plugged in to finally get the USB Audio Class device.

 
 Note that for all the magic to happen automatically pulseaudio >= 1.0 is
 needed, as it contains the kinect-audio.conf profile which fixes audio
 
 Note that for all the magic to happen automatically pulseaudio >= 1.0 is
 needed, as it contains the kinect-audio.conf profile which fixes audio


@@ -34,12 +34,25 @@ Install kinect_upload_fw first:
 it will be copied to /usr/local/sbin by default, assign the PREFIX
 variable on the command line to install it to another location.
 
 it will be copied to /usr/local/sbin by default, assign the PREFIX
 variable on the command line to install it to another location.
 

+Then install the udev rules to automate the firmware loading:
+
+  # make install_udev_rules \
+    FIRMWARE_PATH=/lib/firmware/kinect/UACFirmware
+    LOADER_PATH=/usr/local/sbin/kinect_upload_fw
+

 Then run the firmware fetcher script (remember this is only needed
 once):
 
   # ./kinect_fetch_fw /lib/firmware/kinect
 Then run the firmware fetcher script (remember this is only needed
 once):
 
   # ./kinect_fetch_fw /lib/firmware/kinect

+  # udevadm control --reload-rules

 
 
 The UAC firmware is downloaded from the Microsoft Kinect SDK at
 http://www.kinectforwindows.org, the license of the SDK can be found at
 
 
 The UAC firmware is downloaded from the Microsoft Kinect SDK at
 http://www.kinectforwindows.org, the license of the SDK can be found at

-http://www.kinectforwindows.org/download/EULA.htm
+http://research.microsoft.com/en-us/um/legal/kinectsdk-tou_noncommercial.htm
+
+=== Acknowledgements
+
+A special thanks goes to Steven Toth from http://kernellabs.com, who
+kindly sponsored a Kinect to Antonio Ospite and made kinect-audio-setup
+possible in its current form.