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