README

   1 This library provides support for the Pulse-Eight USB-CEC adapter.
   2
   3 You can find a list of frequently asked questions on the following page:
   4                     http://libcec.pulse-eight.com/faq
   5
   6 ===============================================================================
   7                                 === Linux ===
   8 ===============================================================================
   9
  10 libCEC needs the following dependencies in order to work correctly:
  11 * udev v151 or later
  12 * cdc-acm support compiled into the kernel or available as module
  13 * liblockdev 1.0 or later
  14
  15 To compile libCEC on Linux, you'll need the following dependencies:
  16 * autoconf 2.13 or later
  17 * automake 1.11 or later
  18 * libtool
  19 * gcc 4.2 or later
  20 * liblockdev 1.0 development headers
  21
  22 The following dependencies are recommended. Without them, the adapter can not
  23 be auto-detected.
  24 * pkg-config
  25 * udev development headers v151 or later
  26
  27 To compile, execute the following commands:
  28 # autoreconf -vif
  29 # ./configure
  30 # make
  31 # sudo make install
  32
  33 ===============================================================================
  34                                 === OS-X ===
  35 ===============================================================================
  36
  37 To compile libCEC on OS-X, you'll need the following dependencies:
  38 * autoconf 2.13 or later
  39 * automake 1.11 or later
  40 * pkg-config
  41 * xcode 3.2.6 or later
  42
  43 To compile, execute the following commands (TODO: please verify):
  44 # autoreconf -vif
  45 # ./configure
  46 # make
  47 # sudo make install
  48
  49 # Note: You may need to copy pkg.m4 to your m4 sources directory
  50
  51 ===============================================================================
  52                               === Windows ===
  53 ===============================================================================
  54
  55 To compile libCEC on Windows, you'll need Visual C++ 2010 or Visual Studio 2010
  56 The installer needs the Windows DDK (Driver Development Kit) and Nullsoft's
  57 NSIS.
  58
  59 To compile LibCecSharp on Windows, you'll need Visual C++ 2008 or Visual Studio
  60 2008, because it is compiled against .NET 2.0.
  61
  62 To compile libCEC, follow these instructions:
  63 * open /project/libcec.sln with Visual C++ 2010 or Visual Studio 2010.
  64 * build the project.
  65
  66 To build an installer on Windows:
  67 * download and install NSIS.
  68 * go to /project and execute create-installer.bat to create the installer.
  69 * the installer is stored as /build/libCEC-installer.exe
  70
  71 You will need both Visual Studio 2008 and Visual Studio 2010 to build the
  72 installer from the command line. To build with Visual C++ 2008 and 2010,
  73 you will need to manually build libcec with Visual C++ 2010 and then
  74 build LibCecSharp.sln with Visual Studio 2008. See create-installer.bat
  75 for the required steps.
  76
  77 ===============================================================================
  78                             === Debugging / Testing ===
  79 ===============================================================================
  80
  81 We provide a test client, named cec-client, to debug the device.
  82 To check whether the device can be detected, execute the following command:
  83 * cec-client -l
  84
  85 "cec-client -h" shows a list of commands and options that are available.
  86
  87 ===============================================================================
  88                               === Developers ===
  89 ===============================================================================
  90
  91 We provide a C, C++ and .NET CLR interface to the adapter.
  92
  93 C++ developers:
  94 * the API can be found in /include/cec.h
  95 * an example implementation can be found in /src/testclient/main.cpp
  96
  97 C developers:
  98 * the API can be found in /include/cecc.h
  99
 100 .NET developers:
 101 * add a reference to LibCecSharp.dll
 102 * an example can be found in \src\CecSharpTester\CecSharpClient.cs
 103
 104 ===============================================================================
 105                         === Developers Agreement ===
 106 ===============================================================================
 107
 108 If you wish to contribute to this project, you must first sign our contributors
 109 agreement. Please see http://www.pulse-eight.net/contributors for more
 110 information.