From: Lars Op den Kamp <lars@opdenkamp.eu>
Date: Tue, 1 Nov 2011 21:24:36 +0000 (+0100)
Subject: README updated
X-Git-Tag: upstream/2.2.0~1^2~140
X-Git-Url: https://git.piment-noir.org/?p=deb_libcec.git;a=commitdiff_plain;h=e4e13f5be3f5692847ec8d7a639f0645c3f0bcdb

README updated
---

diff --git a/README b/README
index ebc1a4b..33e625f 100644
--- a/README
+++ b/README
@@ -1,20 +1,29 @@
-For Linux:
+This library provides support for the Pulse-Eight USB-CEC adapter.
+
+To install libCEC on Linux:
 autoreconf -vif
 ./configure --prefix=/usr
 make
 sudo make install
 
-For Windows:
+To install libCEC on Windows:
+Go to /project and execute download-deps.cmd to download Boost.
 Open /project/libcec.sln with Visual C++ 2010 or Visual Studio 2010.
 Build the project.
-Copy libcec.dll and libpthread.dll to your desired destination.
+Copy libcec.dll and pthreadVC2.dll to your desired destination.
+
+To build an installer on Windows:
+Download and install the Windows DDK.
+Download and install NSIS.
+Go to /project and execute download-deps.cmd to download Boost.
+Go to /project and execute create-installer.cmd to create the installer.
+The installer is stored as /project/libCEC-installer.exe
 
 Test the device:
 Run "cec-client -h" to display the options of the test client.
 
 For developers:
-See /include/CECExports.h
-
+See /include/cec.h for the C++ API and /include/cecc.h for the C version.
 
 If you wish to contribute to this project, you must first sign our contributors agreement
 Please see http://www.pulse-eight.net/contributors for more information
\ No newline at end of file