added support for the Raspberry Pi. this needs a recent firmware for the Pi. libCEC...

[deb_libcec.git] / README

diff --git a/README b/README
index f6102041476130d2ec0e228e4b79400ffdf0fa64..5c7364b19882ad5b765448ab7097e4ef45ad2179 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,8 @@
 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 ===
 ===============================================================================
@@ -71,6 +74,31 @@ 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"
+
 ===============================================================================
                             === Debugging / Testing ===
 ===============================================================================