1 <img src="https://dalihub.github.io/images/DaliLogo320x200.png">
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 * [Building and executing test cases](#building-and-executing-test-cases)
11 * [2. GBS Builds](#2-gbs-builds)
12 * [NON-SMACK Targets](#non-smack-targets)
13 * [SMACK enabled Targets](#smack-enabled-targets)
14 * [DEBUG Builds](#debug-builds)
15 * [3. Building for MS Windows](#3-building-for-ms-windows)
16 * Build with the Visual Studio project.
18 * [4. Building for MacOS](#4-building-for-macos)
19 * [Get dependencies](#get-dependencies)
20 * [Set a DALi Environment](#set-a-dali-environment)
21 * [Build the repository](#build-the-repository)
25 ## 1. Building for Ubuntu desktop
27 ### Minimum Requirements
29 - Ubuntu 16.04 or later
31 - Cmake version 3.8.2 or later
33 DALi requires a compiler supporting C++17 features.
35 ### Creating a DALi Environment
37 To build for desktop first ensure ALL sources are selected:
38 - Go to Ubuntu Settings and then to "Software & Updates"
39 - In the "Ubuntu Software" tab, ensure ALL software sources are ticked
41 (This is required because we install some community-maintained free & open-source software)
43 Then you can create a dali-env folder in your home folder with:
45 $ dali-core/build/scripts/dali_env -c
47 This will also download any dependencies that the dali repositories require.
49 You can save the environment variables to a file:
51 $ dali-env/opt/bin/dali_env -s > setenv
53 This process only needs to be done once.
55 Next source these variables:
59 You will have to source these variables every time you open up a new terminal (or you can add to .bashrc if you prefer).
62 ### Building the Repository
64 To build the repository enter the 'build/tizen' folder:
66 $ cd dali-core/build/tizen
68 Then run the following command to set up the build:
70 $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX .
72 If a Debug build is required, then add -DCMAKE_BUILD_TYPE=Debug
78 ### Building and executing test cases
80 See the README.md in dali-core/automated-tests.
86 $ gbs build -A [TARGET_ARCH]
88 ### SMACK enabled Targets
90 $ gbs build -A [TARGET_ARCH] --define "%enable_dali_smack_rules 1"
94 $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
96 ## 3. Building for MS Windows
98 Third party dependencies are built using vcpkg. Instructions on how to install vcpkg can be found in the
99 vcpkg-script folder in the windows-dependencies repository.
101 - Download the windows-dependencies repository from DaliHub
103 $ git clone https://github.com/dalihub/windows-dependencies.git
105 - Read the windows-dependencies/vcpkg-script/Readme.md file for more instructions on how to build and install the third-party dependencies.
107 ### Build with the Visual Studio project
108 Read the windows-dependencies/README.md file for more instructions on how to build and run DALi for MS Windows.
113 It's required the version 3.12.2 of CMake and a Git Bash Shell.
115 * Notes and troubleshoting:
116 It should be possible to use the MS Visual studio Developer Command Prompt (https://docs.microsoft.com/en-us/dotnet/framework/tools/developer-command-prompt-for-vs) to build DALi from the command line.
117 However, the CMake version installed with MS Visual Studio 2017 is a bit out of date and some VCPKG modules require a higher version.
118 This instructions have been tested with CMake 3.12.2 on a Git Bash shell.
120 * Define an environment variable to set the path to the VCPKG folder
122 $ export VCPKG_FOLDER=C:/Users/username/Workspace/VCPKG_TOOL
124 * Define an environment variable to set the path where DALi is going to be installed.
126 $ export DALI_ENV_FOLDER=C:/Users/username/Workspace/dali-env
128 * Execute the following commands to create the makefiles, build and install DALi.
130 $ cmake -g Ninja . -DCMAKE_TOOLCHAIN_FILE=$VCPKG_FOLDER/vcpkg/scripts/buildsystems/vcpkg.cmake -DENABLE_PKG_CONFIGURE=OFF -DENABLE_LINK_TEST=OFF -DCMAKE_INSTALL_PREFIX=$DALI_ENV_FOLDER -DINSTALL_CMAKE_MODULES=ON
131 $ cmake --build . --target install
135 - CMAKE_TOOLCHAIN_FILE ---> Needed to find packages installed by VCPKG.
136 - ENABLE_PKG_CONFIGURE ---> Whether to install pkg configure files (not currently working on MS Windows. CMake modules used instead).
137 - ENABLE_LINK_TEST ---> Whether to enable the link test (not currently working on MS Windows).
138 - CMAKE_INSTALL_PREFIX ---> Were DALi is installed.
139 - INSTALL_CMAKE_MODULES ---> Whether to install the CMake modules (Used by the CMake command find_package() to find previously installed libraries).
140 - ENABLE_DEBUG ---> Whether to build with debug enabled.
142 ## 4. Building for MacOS
146 Dependencies are obtained through [vcpkg](https://github.com/Microsoft/vcpkg#quick-start-unix) and [homebrew](https://docs.brew.sh/Installation.html).
147 Follow each installation guide, to then be able to install the dependencies.
149 From `homebrew` install:
155 $ brew install cairo cmake fontconfig pkg-config
157 And through `vcpkg` install:
184 From `vcpkg` folder, run:
186 $ ./vcpkg install angle bzip2 curl dirent egl-registry expat fribidi getopt gettext giflib glib harfbuzz libexif libffi libiconv libjpeg-turbo libpng libwebp opengl pcre pixman pthreads ragel tool-meson zlib
189 _¹_: At this time, there's a reported bug with the latest MacOS and `vcpkg`'s
190 `glib`, if you got a problem compiling it try adding the following line to
191 `CMakeLists.txt` in the `glib` ports folder:
193 set(ENV{SDKROOT} ${CMAKE_OSX_SYSROOT})
196 ### Set a DALi Environment
197 Now you need to create a `dali-env` folder and then set some environment variables.
199 - `VCPKG_FOLDER` should contain the absolute path to your `vcpkg` installation
200 - `DESKTOP_PREFIX` should contain the absolute path to `dali-env`
202 $ export VCPKG_FOLDER="${HOME}/path/to/vcpkg"
203 $ export DESKTOP_PREFIX="${HOME}/path/to/dail-env"
205 Acordingly to `VCPKG_FOLDER` and `DESKTOP_PREFIX` set:
207 $ export DYLD_LIBRARY_PATH="${DYLD_LIBRARY_PATH}:${VCPKG_FOLDER}/installed/x64-osx/lib"
208 $ export DYLD_LIBRARY_PATH="${DYLD_LIBRARY_PATH}:${DESKTOP_PREFIX}/lib/"
209 $ export DALI_APPLICATION_PACKAGE="${DESKTOP_PREFIX}/share/com.samsung.dali-demo/res/"
210 $ export DALI_WINDOW_WIDTH="480"
211 $ export DALI_WINDOW_HEIGHT="800"
213 If you are going to build `dali` libs with debug option you should also set:
215 $ export DYLD_LIBRARY_PATH="${DYLD_LIBRARY_PATH}:${VCPKG_FOLDER}/installed/x64-osx/debug/lib"
216 $ export DYLD_LIBRARY_PATH="${DYLD_LIBRARY_PATH}:${DESKTOP_PREFIX}/lib/debug"
218 Because we aren't installing at the default resource folder, if you install
219 `dali-toolkit` or `dali-demo` we should first set:
221 $ export DALI_IMAGE_DIR="${DESKTOP_PREFIX}/share/dali/toolkit/images/"
222 $ export DALI_SOUND_DIR="${DESKTOP_PREFIX}/share/dali/toolkit/sounds/"
223 $ export DALI_STYLE_DIR="${DESKTOP_PREFIX}/share/dali/toolkit/styles/"
224 $ export DALI_STYLE_IMAGE_DIR="${DESKTOP_PREFIX}/share/dali/toolkit/styles/images/"
225 $ export DALI_DATA_READ_ONLY_DIR="${DESKTOP_PREFIX}/share/dali/"
227 You will need these variables every time you open up a new terminal. So you may put the exports on a file, here `setenv`, to just source it:
231 ### Build the repository
233 To build the repository enter the 'build/tizen' folder:
235 $ cd dali-core/build/tizen
237 Then run the following command to set up the build:
239 $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_TOOLCHAIN_FILE=$VCPKG_FOLDER/scripts/buildsystems/vcpkg.cmake -DINSTALL_CMAKE_MODULES=ON
241 If a Debug build is required, then add `-DCMAKE_BUILD_TYPE=Debug -DENABLE_DEBUG=ON`