Merge "Added DEBUG_LOG_STREAM for using stream operator" 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 ### Minimum Requirements
22
23  - Ubuntu 14.04 or later
24
25 ### Creating a DALi Environment
26
27 To build for desktop first ensure ALL sources are selected:
28  - Go to Ubuntu Settings and then to "Software & Updates"
29  - In the "Ubuntu Software" tab, ensure ALL software sources are ticked
30
31 (This is required because we install some community-maintained free & open-source software)
32
33 Then you can create a dali-env folder in your home folder with:
34
35          $ dali-core/build/scripts/dali_env -c
36
37 This will also download any dependencies that the dali repositories require.
38
39 You can save the environment variables to a file:
40
41          $ dali-env/opt/bin/dali_env -s > setenv
42
43 This process only needs to be done once.
44
45 Next source these variables:
46
47          $ . setenv
48
49 You will have to source these variables every time you open up a new terminal (or you can add to .bashrc if you prefer).
50
51
52 ### Building the Repository
53
54 To build the repository enter the 'build/tizen' folder:
55
56          $ cd dali-core/build/tizen
57
58 Then run the following commands:
59
60          $ autoreconf --install
61          $ ./configure --prefix=$DESKTOP_PREFIX
62          $ make install -j8
63
64 ### Build target options
65
66 OpenGL ES context:
67
68 When building, the OpenGL ES version of the target should be specified.
69
70 Valid version options are 20, 30, 31
71
72 With configure:
73 Add: *--enable-gles=X*
74
75 With gbs:
76 Add to the gbs build line: *--define "%target_gles_version X"*
77
78
79 ### Building and executing test cases
80
81 See the README.md in dali-core/automated-tests.
82
83 ## 2. GBS Builds
84
85 ### NON-SMACK Targets
86
87          $ gbs build -A [TARGET_ARCH]
88
89 ### SMACK enabled Targets
90
91          $ gbs build -A [TARGET_ARCH] --define "%enable_dali_smack_rules 1"
92
93 ### DEBUG Builds
94
95          $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
96