Merge branch 'master' into release
[deb_libcec.git] / README
1 This library provides support for the Pulse-Eight USB-CEC adapter.
2
3 To install libCEC on Linux:
4 # autoreconf -vif
5 # ./configure --prefix=/usr
6 # make
7 # sudo make install
8
9 To install libCEC on Windows:
10 * open /project/libcec.sln with Visual C++ 2010 or Visual Studio 2010.
11 * build the project.
12 * copy libcec.dll and pthreadVC2.dll to your desired destination.
13
14 To build an installer on Windows:
15 * download and install the Windows DDK.
16 * download and install NSIS.
17 * go to /project and execute create-installer.cmd to create the installer.
18 * the installer is stored as /project/libCEC-installer.exe
19
20 Test the device:
21 * run "cec-client -h" to display the options of the test client.
22
23 For developers:
24 * see /include/cec.h for the C++ API and /include/cecc.h for the C version.
25 * see src/testclient/main.cpp for an example
26
27 For .NET developers:
28 * build project/libcec.sln first
29 * add a reference to LibCecSharp.dll
30 * see src\CecSharpTester\CecSharpClient.cs for an example
31
32 If you wish to contribute to this project, you must first sign our contributors agreement
33 Please see http://www.pulse-eight.net/contributors for more information