[3.0] Ecore Event Handler struct initializations.

[platform/core/uifw/dali-adaptor.git] / README

diff --git a/README b/README
index d33be28..1024acc 100644 (file)
--- a/README
+++ b/README
@@ -1,17 +1,108 @@
-GBS Builds
-==========
+T.O.C.
+======
 
-COMMON Profile
---------------
+ 1.   GBS Builds
+ 1.1. DEBUG Builds
+ 2.   Building for Ubuntu desktop
+ 2.1. Minimum Requirements
+ 2.2. Building the Repository
+ 2.3. Build target options
+ 2.4. Building and executing test cases
+ 3.   Building for Emscripten
+ 3.1. Setup dali-env & build dali-core
+ 3.2. Build the minimal dali-adaptor
+ 3.3. Using the Javascript Build
 
-gbs build -A [TARGET_ARCH]
 
-MOBILE Profile
---------------
+1. GBS Builds
+=============
 
-gbs build -A [TARGET_ARCH] --spec dali-adaptor-mobile.spec
+ gbs build -A [TARGET_ARCH]
 
-WEARABLE Profile
-----------------
+1.1. DEBUG Builds
+-----------------
 
-gbs build -A [TARGET_ARCH] --spec dali-adaptor-wearable.spec
+ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
+
+
+2. Building for Ubuntu desktop
+==============================
+
+2.1. Minimum Requirements
+------------------------
+
+ - Ubuntu 14.04
+ - Environment created using dali_env script in dali-core repository
+
+2.2. Building the Repository
+----------------------------
+
+To build the repository enter the 'build/tizen' folder:
+
+ cd dali-adaptor/build/tizen
+
+Then run the following commands:
+
+ autoreconf --install
+ ./configure --prefix=$DESKTOP_PREFIX
+ make install -j8
+
+
+2.3. Build target options
+-------------------------
+
+OpenGL ES context:
+
+When building, the OpenGL ES version of the target should be specified.
+
+Valid version options are 20, 30, 31 for OpenGL ES versions 2.0, 3.0 and 3.1 respectively.
+
+With configure:
+Add: --enable-gles=X
+
+With gbs:
+Add to the gbs build line: --define "%target_gles_version X"
+
+2.4. Building and executing test cases
+--------------------------------------
+
+See the README.md in dali-adaptor/automated-tests.
+
+
+3. Building for Emscripten
+--------------------------
+
+Currently the build for emscripten uses a minimal adaptor which does not support dali-toolkit.
+
+
+3.1. Setup dali-env & build dali-core
+-------------------------------------
+
+ The build requires the Emscripten SDK, this is installed automatically by running dali_env with the correct parameters.
+ dali_env is part of the dali-core repository.
+ Please see the README within dali-core to setup dali_env and build dali-core.
+
+
+3.2. Build the minimal dali-adaptor
+-----------------------------------
+
+  Use the build.sh script build adaptor.
+  This uses emscriptens emcc to compile byte code to javascript (full OpenGL ES support with stb-image loading library and cpp bindings).
+  Note: Please view the build.sh script for debug build options.
+
+  # cd ./build/emscripten
+  # ./build.sh
+
+
+3.3. Using the Javascript Build
+-------------------------------
+
+ The build will create 1 main Javascript artifact, and its html counterpart; dali-emscripten.js
+
+ This is required by any dali JS app, and must be located in the same directory as the app JS in order for the browser to find it.
+
+ After the build, the necessary artifacts (which include dali-wrapper.js) will be placed in the dali-env directory under opt/share/emscripten:
+
+ dali-env/opt/share/emscripten
+
+ If dali-demo is built, any JS examples will also be placed in this directory, so they are ready to run.