path: root/README
diff options
authorHans de Goede <>2011-07-14 14:51:59 +0200
committerHans de Goede <>2011-07-14 16:22:21 +0200
commitee954d28286408262c6762a22e5e0871e8baa00b (patch)
tree5dc315378a6ea23d7afe33e2dfca4cd47499b74c /README
parent3694b3a4c4d28e3330f68c2ddc6ebe3eef9c0ec2 (diff)
Prepare for the first official release, version 0.3usbredir-0.3
Add COPYING*, Changelog and README files, tweak version in Make.rules and usb-redirection-protocol.txt
Diffstat (limited to 'README')
1 files changed, 33 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..d0fdc6e
--- /dev/null
+++ b/README
@@ -0,0 +1,33 @@
+usbredir README
+usbredir is a protocol for redirection USB traffic from a single USB device,
+to a different (virtual) machine then the one to which the USB device is
+attached. See usb-redirection-protocol.txt for the description / definition
+of this protocol.
+This package contains a number of libraries to help implementing support
+for usbredir and a few simple usbredir applications:
+A library containing the parser for the usbredir protocol
+A library implementing the usb-host (*) side of a usbredir connection.
+All that an application wishing to implement an usb-host needs to do is:
+* Provide a libusb device handle for the device
+* Provide write and read callbacks for the actual transport of usbredir data
+* Monitor for usbredir and libusb read/write events and call their handlers
+*) The side to which the actual USB device is attached, also see the
+definitions section in usb-redirection-protocol.txt
+A simple tcp server usb-host, using usbredirhost
+A small testclient for the usbredir protocol over tcp, using usbredirparser
+Last updated 14 July 2011, by Hans de Goede <>