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.
21 ## 1. Building for Ubuntu desktop
23 ### Minimum Requirements
25 - Ubuntu 16.04 or later
28 DALi requires a compiler supporting C++17 features.
30 ### Creating a DALi Environment
32 To build for desktop first ensure ALL sources are selected:
33 - Go to Ubuntu Settings and then to "Software & Updates"
34 - In the "Ubuntu Software" tab, ensure ALL software sources are ticked
36 (This is required because we install some community-maintained free & open-source software)
38 Then you can create a dali-env folder in your home folder with:
40 $ dali-core/build/scripts/dali_env -c
42 This will also download any dependencies that the dali repositories require.
44 You can save the environment variables to a file:
46 $ dali-env/opt/bin/dali_env -s > setenv
48 This process only needs to be done once.
50 Next source these variables:
54 You will have to source these variables every time you open up a new terminal (or you can add to .bashrc if you prefer).
57 ### Building the Repository
59 To build the repository enter the 'build/tizen' folder:
61 $ cd dali-core/build/tizen
63 Then run the following command to set up the build:
65 $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX .
67 If a Debug build is required, then add -DCMAKE_BUILD_TYPE=Debug
73 ### Building and executing test cases
75 See the README.md in dali-core/automated-tests.
81 $ gbs build -A [TARGET_ARCH]
83 ### SMACK enabled Targets
85 $ gbs build -A [TARGET_ARCH] --define "%enable_dali_smack_rules 1"
89 $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
91 ## 3. Building for MS Windows
93 Third party dependencies are built using vcpkg. Instructions on how to install vcpkg can be found in the
94 vcpkg-script folder in the windows-dependencies repository.
96 - Download the windows-dependencies repository from DaliHub
98 $ git clone https://github.com/dalihub/windows-dependencies.git
100 - Read the windows-dependencies/vcpkg-script/Readme.md file for more instructions on how to build and install the third-party dependencies.
102 ### Build with the Visual Studio project
103 Read the windows-dependencies/README.md file for more instructions on how to build and run DALi for MS Windows.
108 It's required the version 3.12.2 of CMake and a Git Bash Shell.
110 * Notes and troubleshoting:
111 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.
112 However, the CMake version installed with MS Visual Studio 2017 is a bit out of date and some VCPKG modules require a higher version.
113 This instructions have been tested with CMake 3.12.2 on a Git Bash shell.
115 * Define an environment variable to set the path to the VCPKG folder
117 $ export VCPKG_FOLDER=C:/Users/username/Workspace/VCPKG_TOOL
119 * Define an environment variable to set the path where DALi is going to be installed.
121 $ export DALI_ENV_FOLDER=C:/Users/username/Workspace/dali-env
123 * Execute the following commands to create the makefiles, build and install DALi.
125 $ 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
126 $ cmake --build . --target install
130 - CMAKE_TOOLCHAIN_FILE ---> Needed to find packages installed by VCPKG.
131 - ENABLE_PKG_CONFIGURE ---> Whether to install pkg configure files (not currently working on MS Windows. CMake modules used instead).
132 - ENABLE_LINK_TEST ---> Whether to enable the link test (not currently working on MS Windows).
133 - CMAKE_INSTALL_PREFIX ---> Were DALi is installed.
134 - INSTALL_CMAKE_MODULES ---> Whether to install the CMake modules (Used by the CMake command find_package() to find previously installed libraries).
135 - ENABLE_DEBUG ---> Whether to build with debug enabled.