Merge "Remove StereoMode" into devel/master
[platform/core/uifw/dali-core.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          * [Creating a DALi Environment](#creating-a-dali-environment)
9          * [Building the Repository](#building-the-repository)
10          * [Build target options](#build-target-options)
11          * [Building and executing test cases](#building-and-executing-test-cases)
12       * [2. GBS Builds](#2-gbs-builds)
13          * [NON-SMACK Targets](#non-smack-targets)
14          * [SMACK enabled Targets](#smack-enabled-targets)
15          * [DEBUG Builds](#debug-builds)
16
17 # Build Instructions
18
19 ## 1. Building for Ubuntu desktop
20
21 ### Requirements
22
23  - Ubuntu 14.04 or later
24  - GCC version 6
25
26 DALi requires a compiler supporting C++11 features.
27 Ubuntu 16.04 is the first version to offer this by default (GCC v5.4.0).
28
29 GCC version 6 is recommended since it has fixes for issues in version 5
30 e.g. it avoids spurious 'defined but not used' warnings in header files.
31
32
33 ### Creating a DALi Environment
34
35 To build for desktop first ensure ALL sources are selected:
36  - Go to Ubuntu Settings and then to "Software & Updates"
37  - In the "Ubuntu Software" tab, ensure ALL software sources are ticked
38
39 (This is required because we install some community-maintained free & open-source software)
40
41 Then you can create a dali-env folder in your home folder with:
42
43          $ dali-core/build/scripts/dali_env -c
44
45 This will also download any dependencies that the dali repositories require.
46
47 You can save the environment variables to a file:
48
49          $ dali-env/opt/bin/dali_env -s > setenv
50
51 This process only needs to be done once.
52
53 Next source these variables:
54
55          $ . setenv
56
57 You will have to source these variables every time you open up a new terminal (or you can add to .bashrc if you prefer).
58
59
60 ### Building the Repository
61
62 To build the repository enter the 'build/tizen' folder:
63
64          $ cd dali-core/build/tizen
65
66 Then run the following commands:
67
68          $ autoreconf --install
69          $ ./configure --prefix=$DESKTOP_PREFIX
70          $ make install -j8
71
72 ### Build target options
73
74 OpenGL ES context:
75
76 When building, the OpenGL ES version of the target should be specified.
77
78 Valid version options are 20, 30, 31
79
80 With configure:
81 Add: *--enable-gles=X*
82
83 With gbs:
84 Add to the gbs build line: *--define "%target_gles_version X"*
85
86
87 ### Building and executing test cases
88
89 See the README.md in dali-core/automated-tests.
90
91 ## 2. GBS Builds
92
93 ### NON-SMACK Targets
94
95          $ gbs build -A [TARGET_ARCH]
96
97 ### SMACK enabled Targets
98
99          $ gbs build -A [TARGET_ARCH] --define "%enable_dali_smack_rules 1"
100
101 ### DEBUG Builds
102
103          $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
104