update README

Signed-off-by: Andy Green <andy.green@linaro.org>

1 files changed, 38 insertions, 4 deletions

diff --git a/README b/README
index 5b580f2..2074e1b 100644
--- a/README
+++ b/README
@@ -1,11 +1,45 @@
 2012-11-14  Andy Green <andy.green@linaro.org>
 
-MB86H55 driver / commandline app
-as used in IEI HDC-301E
+Introduction
+------------
+
+These are updated driver and text menu app for Linux for an IEI HDC-301E
+HDMI-HDMI video capture PCI Express card, based on Fujitsu MB86H55 LSI.
 
 http://www.ieiworld.com/product_groups/industrial/content.aspx?keyword=HDC-301E
 
 Originally came from the "SDK" link on the page above, but the driver code was
-rotted against 3.6 kernels.
+rotted against 3.6/3.7 kernels and both the driver and app were not 64-bit
+clean.
+
+Sources are marked up as GPL2, including the userland.
+
+
+Restrictions
+------------
+
+Right now there's a text-menu based control app which won't accept automation
+well.
+
+
+Building
+--------
+
+You need your kernel build package to build an OOT module against.
+
+The script ./install.sh attempts to build and install everything, then insert
+the module and create the /dev node(s).  I added a udev rule which should
+do that automatically afterwards.  The node is in "video" group.
+
+There's a firmware blob, which is installed by the script into /lib/firmware.
+
+
+Usage
+-----
+
+The install script copies the menu app as "/usr/local/bin/hdcapture".
+
+You should be able to run this, use option 6 to select the capture rate and
+then option 1 to capture to the default file ./stream-0.mpg, until you
+press enter.
 
-Sources are marked up as GPL2, including the userland