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