1 files changed, 95 insertions, 0 deletions
diff --git a/README.TXT b/README.TXT
new file mode 100755
index 0000000..dd50d2e
--- /dev/null
+++ b/README.TXT
@@ -0,0 +1,95 @@
+This package includes the jointSPACE remote application SDK in source format.
+It allows you to port the SDK to new architectures or simply recompile it for the supported ones.
+
+Architecture currently supported are:
+- linux (X86 or other platforms)
+- cygwin (X86)
+- macos (Apple Mac)
+- dslinux (NDS) 
+- Apple iOS (iPhone, iPod, iPad...)
+- Android 
+
+The SDK includes all what you need to create native TV Remote Applications on remote devices:
+header and librarie files.
+
+
+Building
+--------
+Compile the SDK libraries (libdirectfb.o...):
+  make -f makefile.voodoo.<architecture>
+
+For Android and iPhone, don't do the above but use the dedicated build script instead:
+e.g. for Android : 
+1) set the variable NDK_PATH inside "build_for_android.sh" to the absolute location where your android NDK is installed.
+   You need to install "android-ndk-r4-windows-crystax-4" to compile (from SDK V1.3.1 onward)
+2) Insure that the line containing -DVOODOO_PLAY_FAKE=1 is uncommented.
+   Some phones are unable to receive UDP message which makes the jointSPACE
+   discovery mechanism not working at all. This patch allows at least to detect
+   directfb capable device (e.g. jointSPACE TV) but won't allow to identify
+   the device as such (friendly name). We hope that can be fixed soon.  
+   Some Android devices don't have that issue and don't need  that change (best is to try with and without)   
+3)./build_for_android.sh
+
+
+
+Create the "DirectFB_Voodoo" package containing the SDK libraries and header files.
+  make -f makefile.voodoo.<architecture> package
+
+
+
+
+Typical issues:
+- $CC or $LD not reachable: adapt your $PATH
+- pthread development files not installed
+- incompatible shell: build-package.sh rely on bash being installed as /bin/sh.
+- wrong permissions: chmod a+rwx build-package.sh.
+- problems to generate DirectFB_Voodoo.tar.gz: this step might fail if your system does not support tar ball generation.
+
+
+Installing
+----------
+Copy "DirectFB_Voodoo" (generated directory) where your remote application samples will be developped (typically you will
+create a subdirectory next to "DirectFB_Voodoo" for each sample you will create) 
+
+For Android, refer to this directory from the SDK jni makefile (Android.mk)
+
+
+History:
+-------
+V1.3.1_beta5: 2012-12-21
+Changes:
+  - Added support for few RC keys in jslibrc for 2k13 products
+
+V1.3.1_beta4: 2012-11-6
+Changes:
+  - Fixed voodoo player problem: "Once the app goes into background, tv disconnects".   
+
+	V1.3.1_beta3: 2012-05-20
+Changes:
+  - fixed jslibrc HID events and 2k12 products  
+  - Minor android fixes
+
+V1.3.1_beta2: 2011-10-31
+Changes:
+  - Extended jslibrc with HID events support and 2k11 RC API (xxxEx)  
+  - Minor fixes
+  - note: requires min gcc 4.3 (macos, cygwin...)
+
+V1.3.1_beta1: 2011-08-31
+Changes:
+  - jslibrc extended to 2k11 functionalities
+  - Adapted RC6 tables for 2k11H2 sets
+
+V1.3.1: 2011-06-20
+Creation: (New baseline for 2k11R3 supporting compression and new features)
+  - Compressed and raw connection support (redesigned)
+  - fix HW cursor and few other problems
+
+
+
+
+
+
+
+
+