README

   1 This library provides support for the Pulse-Eight USB-CEC adapter.
   2
   3 ===============================================================================
   4                                 === Linux ===
   5 ===============================================================================
   6
   7 libCEC needs the following dependencies in order to work correctly:
   8 * udev v151 or later
   9 * cdc-acm support compiled into the kernel or available as module
  10
  11 To compile libCEC on Linux, you'll need the following dependencies:
  12 * autoconf 2.13 or later
  13 * automake 1.11 or later
  14 * udev development headers v151 or later
  15 * gcc 4.2 or later
  16
  17 To compile, execute the following commands:
  18 # autoreconf -vif
  19 # ./configure --prefix=/usr
  20 # make
  21 # sudo make install
  22
  23 ===============================================================================
  24                                 === OS-X ===
  25 ===============================================================================
  26
  27 To compile libCEC on OS-X, you'll need the following dependencies:
  28 * autoconf 2.13 or later
  29 * automake 1.11 or later
  30 * xcode (TODO: version?)
  31
  32 To compile, execute the following commands (TODO: please verify):
  33 # autoreconf -vif
  34 # ./configure --prefix=/usr
  35 # make
  36 # sudo make install
  37
  38 ===============================================================================
  39                               === Windows ===
  40 ===============================================================================
  41
  42 To compile libCEC on Windows, you'll need Visual C++ 2010 or Visual Studio 2010
  43 The installer needs the Windows DDK (Driver Development Kit) and Nullsoft's
  44 NSIS.
  45
  46 To compile libCEC, follow these instructions:
  47 * open /project/libcec.sln with Visual C++ 2010 or Visual Studio 2010.
  48 * build the project.
  49
  50 To build an installer on Windows:
  51 * download and install the Windows DDK.
  52 * download and install NSIS.
  53 * go to /project and execute create-installer.cmd to create the installer.
  54 * the installer is stored as /project/libCEC-installer.exe
  55
  56 ===============================================================================
  57                             === Debugging / Testing ===
  58 ===============================================================================
  59
  60 We provide a test client, named cec-client, to debug the device.
  61 To check whether the device can be detected, execute the following command:
  62 * cec-client -l
  63
  64 "cec-client -h" shows a list of commands and options that are available.
  65
  66 ===============================================================================
  67                               === Developers ===
  68 ===============================================================================
  69
  70 We provide a C, C++ and .NET CLR interface to the adapter.
  71
  72 C++ developers:
  73 * the API can be found in /include/cec.h
  74 * an example implementation can be found in /src/testclient/main.cpp
  75
  76 C developers:
  77 * the API can be found in /include/cecc.h
  78
  79 .NET developers:
  80 * add a reference to LibCecSharp.dll
  81 * an example can be found in \src\CecSharpTester\CecSharpClient.cs
  82
  83 ===============================================================================
  84                         === Developers Agreement ===
  85 ===============================================================================
  86
  87 If you wish to contribute to this project, you must first sign our contributors
  88 agreement. Please see http://www.pulse-eight.net/contributors for more
  89 information.