[3.0] Version up of tizen remote surface protocol
[platform/core/uifw/dali-adaptor.git] / README
1 T.O.C.
2 ======
3
4  1.   GBS Builds
5  1.1. DEBUG Builds
6  2.   Building for Ubuntu desktop
7  2.1. Minimum Requirements
8  2.2. Building the Repository
9  2.3. Build target options
10  2.4. Building and executing test cases
11  3.   Building for Emscripten
12  3.1. Setup dali-env & build dali-core
13  3.2. Build the minimal dali-adaptor
14  3.3. Using the Javascript Build
15
16
17 1. GBS Builds
18 =============
19
20  gbs build -A [TARGET_ARCH]
21
22 1.1. DEBUG Builds
23 -----------------
24
25  gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
26
27
28 2. Building for Ubuntu desktop
29 ==============================
30
31 2.1. Minimum Requirements
32 ------------------------
33
34  - Ubuntu 14.04
35  - Environment created using dali_env script in dali-core repository
36
37 2.2. Building the Repository
38 ----------------------------
39
40 To build the repository enter the 'build/tizen' folder:
41
42  cd dali-adaptor/build/tizen
43
44 Then run the following commands:
45
46  autoreconf --install
47  ./configure --prefix=$DESKTOP_PREFIX
48  make install -j8
49
50
51 2.3. Build target options
52 -------------------------
53
54 OpenGL ES context:
55
56 When building, the OpenGL ES version of the target should be specified.
57
58 Valid version options are 20, 30, 31 for OpenGL ES versions 2.0, 3.0 and 3.1 respectively.
59
60 With configure:
61 Add: --enable-gles=X
62
63 With gbs:
64 Add to the gbs build line: --define "%target_gles_version X"
65
66 2.4. Building and executing test cases
67 --------------------------------------
68
69 See the README.md in dali-adaptor/automated-tests.
70
71
72 3. Building for Emscripten
73 --------------------------
74
75 Currently the build for emscripten uses a minimal adaptor which does not support dali-toolkit.
76
77
78 3.1. Setup dali-env & build dali-core
79 -------------------------------------
80
81  The build requires the Emscripten SDK, this is installed automatically by running dali_env with the correct parameters.
82  dali_env is part of the dali-core repository.
83  Please see the README within dali-core to setup dali_env and build dali-core.
84
85
86 3.2. Build the minimal dali-adaptor
87 -----------------------------------
88
89   Use the build.sh script build adaptor.
90   This uses emscriptens emcc to compile byte code to javascript (full OpenGL ES support with stb-image loading library and cpp bindings).
91   Note: Please view the build.sh script for debug build options.
92
93   # cd ./build/emscripten
94   # ./build.sh
95
96
97 3.3. Using the Javascript Build
98 -------------------------------
99
100  The build will create 1 main Javascript artifact, and its html counterpart; dali-emscripten.js
101
102  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.
103
104  After the build, the necessary artifacts (which include dali-wrapper.js) will be placed in the dali-env directory under opt/share/emscripten:
105
106  dali-env/opt/share/emscripten
107
108  If dali-demo is built, any JS examples will also be placed in this directory, so they are ready to run.