win32: don't try to rename the installer file when it's not being built on the builds...
[deb_libcec.git] / README
CommitLineData
e4e13f5b
LOK
1This library provides support for the Pulse-Eight USB-CEC adapter.
2
0e8ac6a7
LOK
3===============================================================================
4 === Linux ===
5===============================================================================
6
7libCEC 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
11To compile libCEC on Linux, you'll need the following dependencies:
12* autoconf 2.13 or later
13* automake 1.11 or later
10ccd54d 14* pkg-config
80feba65 15* libtool
0e8ac6a7
LOK
16* udev development headers v151 or later
17* gcc 4.2 or later
18
19To 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
29To compile libCEC on OS-X, you'll need the following dependencies:
30* autoconf 2.13 or later
31* automake 1.11 or later
10ccd54d 32* pkg-config
4777f253 33* xcode 3.2.6 or later
0e8ac6a7
LOK
34
35To compile, execute the following commands (TODO: please verify):
f5ccf647
LOK
36# autoreconf -vif
37# ./configure --prefix=/usr
38# make
39# sudo make install
abbca718 40
4777f253
ME
41# Note: You may need to copy pkg.m4 to your m4 sources directory
42
0e8ac6a7
LOK
43===============================================================================
44 === Windows ===
45===============================================================================
46
47To compile libCEC on Windows, you'll need Visual C++ 2010 or Visual Studio 2010
48The installer needs the Windows DDK (Driver Development Kit) and Nullsoft's
49NSIS.
50
51To compile libCEC, follow these instructions:
f5ccf647
LOK
52* open /project/libcec.sln with Visual C++ 2010 or Visual Studio 2010.
53* build the project.
e4e13f5b
LOK
54
55To build an installer on Windows:
f5ccf647
LOK
56* download and install the Windows DDK.
57* download and install NSIS.
f5ccf647
LOK
58* go to /project and execute create-installer.cmd to create the installer.
59* the installer is stored as /project/libCEC-installer.exe
abbca718 60
0e8ac6a7
LOK
61===============================================================================
62 === Debugging / Testing ===
63===============================================================================
64
65We provide a test client, named cec-client, to debug the device.
66To check whether the device can be detected, execute the following command:
67* cec-client -l
68
69"cec-client -h" shows a list of commands and options that are available.
abbca718 70
0e8ac6a7
LOK
71===============================================================================
72 === Developers ===
73===============================================================================
61f3c2ad 74
0e8ac6a7
LOK
75We provide a C, C++ and .NET CLR interface to the adapter.
76
77C++ developers:
78* the API can be found in /include/cec.h
79* an example implementation can be found in /src/testclient/main.cpp
80
81C developers:
82* the API can be found in /include/cecc.h
83
84.NET developers:
61f3c2ad 85* add a reference to LibCecSharp.dll
0e8ac6a7
LOK
86* an example can be found in \src\CecSharpTester\CecSharpClient.cs
87
88===============================================================================
89 === Developers Agreement ===
90===============================================================================
cc30d5c9 91
0e8ac6a7
LOK
92If you wish to contribute to this project, you must first sign our contributors
93agreement. Please see http://www.pulse-eight.net/contributors for more
94information.