Add debian package patches.

[deb_libcec.git] / README

diff --git a/README b/README
index de118ea8befe2edd212a0f2fd247a68e7eb1186d..3f2ee2214009c741e1bf2ccb2a7cc4e37b0104fe 100644 (file)
--- a/README
+++ b/README
@@ -4,7 +4,7 @@ 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:
@@ -25,7 +25,7 @@ be auto-detected.
 * udev development headers v151 or later
 
 To compile, execute the following commands:
-# autoreconf -vif
+# ./bootstrap 
 # ./configure
 # make
 # sudo make install
@@ -40,8 +40,8 @@ To compile libCEC on OS-X, you'll need the following dependencies:
 * pkg-config
 * xcode 3.2.6 or later
 
-To compile, execute the following commands (TODO: please verify):
-# autoreconf -vif
+To compile, execute the following command:
+# ./bootstrap 
 # ./configure
 # make
 # sudo make install
@@ -52,15 +52,16 @@ To compile, execute the following commands (TODO: please verify):
                               === Windows ===
 ===============================================================================
 
-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 libCEC on Windows, you'll need Visual Studio 2012 and Visual Studio
+or Visual C++ 2008. The latter is needed to build LibCecSharp for .Net
+Framework 2.0.
 
-To compile LibCecSharp on Windows, you'll need Visual C++ 2008 or Visual Studio
-2008, because it is compiled against .NET 2.0.
+The adapter detection code needs the Windows DDK (Driver Development Kit).
+
+To create an installer, you'll need Nullsoft's NSIS.
 
 To compile libCEC, follow these instructions:
-* open /project/libcec.sln with Visual C++ 2010 or Visual Studio 2010.
+* open /project/libcec.sln with Visual Studio 2012.
 * build the project.
 
 To build an installer on Windows:
@@ -68,12 +69,6 @@ To build an installer on Windows:
 * 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 ===
 ===============================================================================
@@ -100,18 +95,18 @@ for 'configure':
 --with-rpi-lib-path="/path/to/libbcm_host.so"
 
 ===============================================================================
-                           === CuBox ===
+                           === CuBox / TDA995x ===
 ===============================================================================
 
-Solid-Run's CuBox uses an HDMI tranceiver by NXP. The device driver for this,
-which is based on an SDK by the chip vendor, is built into the kernel. The
-following options for 'configure' have been introduced:
+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:
---enable-cubox
+To enable support for the CuBox / TDA995x:
+--enable-tda995x
 
-To specify the path for the NXP SDK:
---with-nxp-toolkit-path='path/to/linux/drivers/video/dovefb/nxp_hdmi'
+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.
@@ -120,6 +115,10 @@ If the toolkit path is not specified, it is assumed that a directory named
                             === 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