Merge branch 'master' into release

[deb_libcec.git] / README

diff --git a/README b/README
index ebc1a4bfdc720e5ef58f86367a632b3085ea92c3..5ef90e3c5f830551c79b8b23a4c46ab7ed973df1 100644 (file)
--- a/README
+++ b/README
@@ -1,20 +1,33 @@
-For Linux:
-autoreconf -vif
-./configure --prefix=/usr
-make
-sudo make install
+This library provides support for the Pulse-Eight USB-CEC adapter.
 
-For Windows:
-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.
+To install libCEC on Linux:
+# autoreconf -vif
+# ./configure --prefix=/usr
+# make
+# sudo make install
+
+To install libCEC on Windows:
+* open /project/libcec.sln with Visual C++ 2010 or Visual Studio 2010.
+* build the project.
+* 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 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.
+* 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.
+* see src/testclient/main.cpp for an example
 
+For .NET developers:
+* build project/libcec.sln first
+* add a reference to LibCecSharp.dll
+* see src\CecSharpTester\CecSharpClient.cs for an example
 
 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