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          * [Building and executing test cases](#building-and-executing-test-cases)
  10       * [2. GBS Builds](#2-gbs-builds)
  11          * [NON-SMACK Targets](#non-smack-targets)
  12          * [SMACK enabled Targets](#smack-enabled-targets)
  13          * [DEBUG Builds](#debug-builds)
  14       * [3. Building for MS Windows](#3-building-for-ms-windows)
  15          * Build with the Visual Studio project.
  16          * Build with CMake.
  17       * [4. Building for MacOS](#4-building-for-macos)
  18    * [DALi Scene3D](#dali-scene3d)
  19
  20 # Build Instructions
  21
  22 ## 1. Building for Ubuntu desktop
  23
  24 ### Requirements
  25
  26  - Ubuntu 16.04 or later
  27  - Environment created using dali_env script in dali-core repository
  28  - GCC version 9
  29  - Cmake version 3.8.2 or later
  30
  31 DALi requires a compiler supporting C++17 features.
  32
  33 ### Building the Repository
  34
  35 To build the repository enter the 'build/tizen' folder:
  36
  37          $ cd dali-toolkit/build/tizen
  38
  39 Then run the following command to set up the build:
  40
  41          $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX .
  42
  43 If a Debug build is required, then add -DCMAKE_BUILD_TYPE=Debug
  44
  45 To build run:
  46
  47          $ make install -j8
  48
  49 ### Building and executing test cases
  50
  51 See the README.md in dali-toolkit/automated-tests.
  52
  53 ## 2. GBS Builds
  54
  55 ### NON-SMACK Targets
  56
  57          $ gbs build -A [TARGET_ARCH]
  58
  59 ### SMACK enabled Targets
  60
  61          $ gbs build -A [TARGET_ARCH] --define "%enable_dali_smack_rules 1"
  62
  63 ### DEBUG Builds
  64
  65          $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
  66
  67
  68 ## 3. Building for MS Windows
  69
  70 Third party dependencies are built using vcpkg. Instructions on how to install vcpkg can be found in the
  71 vcpkg-script folder in the windows-dependencies repository.
  72
  73 - Download the windows-dependencies repository from DaliHub
  74
  75          $ git clone https://github.com/dalihub/windows-dependencies.git
  76
  77 - Read the windows-dependencies/vcpkg-script/Readme.md file for more instructions on how to build and install the third-party dependencies.
  78
  79 ### Build with the Visual Studio project
  80   Read the windows-dependencies/README.md file for more instructions on how to build and run DALi for MS Windows.
  81
  82 ### Build with CMake
  83
  84   * Requirements
  85     It's required the version 3.12.2 of CMake and a Git Bash Shell.
  86
  87   * Notes and troubleshoting:
  88     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.
  89     However, the CMake version installed with MS Visual Studio 2017 is a bit out of date and some VCPKG modules require a higher version.
  90     This instructions have been tested with CMake 3.12.2 on a Git Bash shell.
  91
  92   * Define an environment variable to set the path to the VCPKG folder
  93
  94     $ export VCPKG_FOLDER=C:/Users/username/Workspace/VCPKG_TOOL
  95
  96   * Define an environment variable to set the path where DALi is going to be installed.
  97
  98     $ export DALI_ENV_FOLDER=C:/Users/username/Workspace/dali-env
  99
 100   * Execute the following commands to create the makefiles, build and install DALi.
 101
 102     $ 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 -DUSE_DEFAULT_RESOURCE_DIR=OFF
 103     $ cmake --build . --target install
 104
 105
 106   * Options:
 107     - CMAKE_TOOLCHAIN_FILE     ---> Needed to find packages installed by VCPKG.
 108     - ENABLE_PKG_CONFIGURE     ---> Whether to install pkg configure files (not currently working on MS Windows. CMake modules used instead).
 109     - ENABLE_LINK_TEST         ---> Whether to enable the link test (not currently working on MS Windows).
 110     - CMAKE_INSTALL_PREFIX     ---> Were DALi is installed.
 111     - INSTALL_CMAKE_MODULES    ---> Whether to install the CMake modules (Used by the CMake command find_package() to find previously installed libraries).
 112     - ENABLE_DEBUG             ---> Whether to build with debug enabled.
 113     - USE_DEFAULT_RESOURCE_DIR ---> Whether to use the default resource folders. Otherwise set environment variables for DALI_IMAGE_DIR, DALI_SOUND_DIR, DALI_STYLE_DIR, DALI_STYLE_IMAGE_DIR and DALI_DATA_READ_ONLY_DIR
 114
 115 ## 4. Building for MacOS
 116
 117 It is assumed that the DALi environment has been set up & both DALi Core & Adaptor have been built accordingly.
 118
 119 To build the repository enter the 'build/tizen' folder:
 120 ```zsh
 121 % cd dali-toolkit/build/tizen
 122 ```
 123 Then run the following command to set up the build:
 124 ```zsh
 125 % cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_TOOLCHAIN_FILE=$VCPKG_FOLDER/scripts/buildsystems/vcpkg.cmake -DINSTALL_CMAKE_MODULES=ON
 126 ```
 127 If a Debug build is required, then add `-DCMAKE_BUILD_TYPE=Debug -DENABLE_DEBUG=ON`
 128
 129 To build, run:
 130 ```zsh
 131 % make install -j8
 132 ```
 133
 134 # DALi Scene3D
 135
 136 For information about the DALi Scene3D library, refer to dali-scene3d/README.md.