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 3.2.6 or later
  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 # Note: You may need to copy pkg.m4 to your m4 sources directory
  42
  43 ===============================================================================
  44                               === Windows ===
  45 ===============================================================================
  46
  47 To compile libCEC on Windows, you'll need Visual C++ 2010 or Visual Studio 2010
  48 The installer needs the Windows DDK (Driver Development Kit) and Nullsoft's
  49 NSIS.
  50
  51 To compile LibCecSharp on Windows, you'll need Visual C++ 2008 or Visual Studio
  52 2008, because it is compiled against .NET 2.0.
  53
  54 To compile libCEC, follow these instructions:
  55 * open /project/libcec.sln with Visual C++ 2010 or Visual Studio 2010.
  56 * build the project.
  57
  58 To build an installer on Windows:
  59 * download and install NSIS.
  60 * go to /project and execute create-installer.bat to create the installer.
  61 * the installer is stored as /build/libCEC-installer.exe
  62
  63 You will need both Visual Studio 2008 and Visual Studio 2010 to build the
  64 installer from the command line. To build with Visual C++ 2008 and 2010,
  65 you will need to manually build libcec with Visual C++ 2010 and then
  66 build LibCecSharp.sln with Visual Studio 2008. See create-installer.bat
  67 for the required steps.
  68
  69 ===============================================================================
  70                             === Debugging / Testing ===
  71 ===============================================================================
  72
  73 We provide a test client, named cec-client, to debug the device.
  74 To check whether the device can be detected, execute the following command:
  75 * cec-client -l
  76
  77 "cec-client -h" shows a list of commands and options that are available.
  78
  79 ===============================================================================
  80                               === Developers ===
  81 ===============================================================================
  82
  83 We provide a C, C++ and .NET CLR interface to the adapter.
  84
  85 C++ developers:
  86 * the API can be found in /include/cec.h
  87 * an example implementation can be found in /src/testclient/main.cpp
  88
  89 C developers:
  90 * the API can be found in /include/cecc.h
  91
  92 .NET developers:
  93 * add a reference to LibCecSharp.dll
  94 * an example can be found in \src\CecSharpTester\CecSharpClient.cs
  95
  96 ===============================================================================
  97                         === Developers Agreement ===
  98 ===============================================================================
  99
 100 If you wish to contribute to this project, you must first sign our contributors
 101 agreement. Please see http://www.pulse-eight.net/contributors for more
 102 information.