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