use CCECTypeUtils::ToString(const cec_command& command) in CCECProcessor

[deb_libcec.git] / README

diff --git a/README b/README
index c60a92110b70d14b70ac42ac79541f0faf8bd7ea..f25c53946cbc5d64fd1772c48977a9fa3f0f191d 100644 (file)
--- a/README
+++ b/README
@@ -1,24 +1,32 @@
 This library provides support for the Pulse-Eight USB-CEC adapter.
 
+You can find a list of frequently asked questions on the following page:
+                    http://libcec.pulse-eight.com/faq
+
 ===============================================================================
-                                === Linux ===
+                             === Linux & BSD ===
 ===============================================================================
 
 libCEC needs the following dependencies in order to work correctly:
 * udev v151 or later
 * cdc-acm support compiled into the kernel or available as module
+* liblockdev 1.0 or later
 
 To compile libCEC on Linux, you'll need the following dependencies:
 * autoconf 2.13 or later
 * automake 1.11 or later
-* pkg-config
 * libtool
-* udev development headers v151 or later
 * gcc 4.2 or later
+* liblockdev 1.0 development headers
+
+The following dependencies are recommended. Without them, the adapter can not
+be auto-detected.
+* pkg-config
+* udev development headers v151 or later
 
 To compile, execute the following commands:
-# autoreconf -vif
-# ./configure --prefix=/usr
+# ./bootstrap 
+# ./configure
 # make
 # sudo make install
 
@@ -30,14 +38,16 @@ To compile libCEC on OS-X, you'll need the following dependencies:
 * autoconf 2.13 or later
 * automake 1.11 or later
 * pkg-config
-* xcode (TODO: version?)
+* xcode 3.2.6 or later
 
-To compile, execute the following commands (TODO: please verify):
-# autoreconf -vif
-# ./configure --prefix=/usr
+To compile, execute the following command:
+# ./bootstrap 
+# ./configure
 # make
 # sudo make install
 
+# Note: You may need to copy pkg.m4 to your m4 sources directory
+
 ===============================================================================
                               === Windows ===
 ===============================================================================
@@ -46,20 +56,74 @@ To compile libCEC on Windows, you'll need Visual C++ 2010 or Visual Studio 2010
 The installer needs the Windows DDK (Driver Development Kit) and Nullsoft's
 NSIS.
 
+To compile LibCecSharp on Windows, you'll need Visual C++ 2008 or Visual Studio
+2008, because it is compiled against .NET 2.0.
+
 To compile libCEC, follow these instructions:
 * open /project/libcec.sln with Visual C++ 2010 or Visual Studio 2010.
 * build the project.
 
 To build an installer on Windows:
-* download and install the Windows DDK.
 * download and install NSIS.
-* go to /project and execute create-installer.cmd to create the installer.
-* the installer is stored as /project/libCEC-installer.exe
+* go to /project and execute create-installer.bat to create the installer.
+* the installer is stored as /build/libCEC-installer.exe
+
+You will need both Visual Studio 2008 and Visual Studio 2010 to build the
+installer from the command line. To build with Visual C++ 2008 and 2010,
+you will need to manually build libcec with Visual C++ 2010 and then
+build LibCecSharp.sln with Visual Studio 2008. See create-installer.bat
+for the required steps.
+
+===============================================================================
+                           === Raspberry Pi ===
+===============================================================================
+
+We've included a script that builds libCEC with support for the Raspberry Pi
+in /project/RPi/build.sh. This script pulls in the latest toolchain and
+firmware, builds the necessary dependencies, and finally builds libCEC. The
+result will be a softfp build.
+
+To build libCEc on your development machine, follow these instructions:
+* run '/project/RPi/build.sh /desired/destination/path/for/binaries'
+* run 'make install'
+
+To build libCEC on the Pi itself, just follow the instructions for Linux.
+The configure script automatically checks whether the required headers and
+libraries can be found.
+
+To specify the path of the Raspberry Pi's development headers, use the
+following option for 'configure':
+--with-rpi-include-path="/path/to/opt/vc/include"
+
+To specify the path of the Raspberry Pi's libraries, use the following option
+for 'configure':
+--with-rpi-lib-path="/path/to/libbcm_host.so"
+
+===============================================================================
+                           === CuBox / TDA995x ===
+===============================================================================
+
+Solid-Run's CuBox uses a combined HDMI tranceiver / CEC controller by NXP. The
+device driver for it is based on an SDK by the chip vendor and is compiled into
+the Linux kernel. The following options for 'configure' have been introduced:
+
+To enable support for the CuBox / TDA995x:
+--enable-tda995x
+
+To specify the path to the SDK part of the kernel driver:
+--with-tda995x-toolkit-path='path/to/linux/drivers/video/dovefb/nxp_hdmi'
+
+If the toolkit path is not specified, it is assumed that a directory named
+'nxp_hdmi' (or a link to it) exists in the top level of the source tree.
 
 ===============================================================================
                             === Debugging / Testing ===
 ===============================================================================
 
+To compile libCEC with extensive debugging output, pass the following argument
+to configure on Linux/OS-X/BSD:
+--enable-debug
+
 We provide a test client, named cec-client, to debug the device.
 To check whether the device can be detected, execute the following command:
 * cec-client -l