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          * [Build target options](#build-target-options)
  10          * [Building and executing test cases](#building-and-executing-test-cases)
  11       * [2. GBS Builds](#2-gbs-builds)
  12          * [DEBUG Builds](#debug-builds)
  13          * [DS-5 Streamline Trace Builds](#ds-5-streamline-trace-builds)
  14       * [3. Building for MS Windows](#3-building-for-ms-windows)
  15          * [Build with the Visual Studio project](#build-with-the-visual-studio-project)
  16          * [Build with CMake](#build-with-cmake)
  17       * [4. Building for MacOS](#4-building-for-macos)
  18
  19 # Build Instructions
  20
  21 ## 1. Building for Ubuntu desktop
  22
  23 ### Minimum Requirements
  24
  25  - Ubuntu 16.04 or later
  26  - Environment created using dali_env script in dali-core repository
  27  - GCC version 9
  28  - Cmake version 3.8.2 or later
  29
  30 DALi requires a compiler supporting C++17 features.
  31
  32 ### Building the Repository
  33
  34 To build the repository enter the 'build/tizen' folder:
  35
  36          $ cd dali-adaptor/build/tizen
  37
  38 Then run the following command to set up the build:
  39
  40          $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX .
  41
  42 If a Debug build is required, then add -DCMAKE_BUILD_TYPE=Debug
  43
  44 To build run:
  45
  46          $ make install -j8
  47
  48 ### Building and executing test cases
  49
  50 See the README.md in dali-adaptor/automated-tests.
  51
  52 ## 2. GBS Builds
  53
  54          $ gbs build -A [TARGET_ARCH]
  55
  56 ### DEBUG Builds
  57
  58          $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
  59
  60
  61 ### DS-5 Streamline Trace Builds
  62
  63 By default, when using a GBS build, trace is enabled but Ttrace is used.
  64 If you want to use DS-5 Streamline instead then do the following:
  65
  66          $ gbs build -A [TARGET_ARCH] --define "%enable_streamline 1"
  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 -DPROFILE_LCASE=windows
 103     $ cmake --build . --target install
 104
 105   * Options:
 106     - CMAKE_TOOLCHAIN_FILE  ---> Needed to find packages installed by VCPKG.
 107     - ENABLE_PKG_CONFIGURE  ---> Whether to install pkg configure files (not currently working on MS Windows. CMake modules used instead).
 108     - ENABLE_LINK_TEST      ---> Whether to enable the link test (not currently working on MS Windows).
 109     - CMAKE_INSTALL_PREFIX  ---> Were DALi is installed.
 110     - INSTALL_CMAKE_MODULES ---> Whether to install the CMake modules (Used by the CMake command find_package() to find previously installed libraries).
 111     - PROFILE_LCASE         ---> The platform (must be windows).
 112     - ENABLE_DEBUG          ---> Whether to build with debug enabled.
 113
 114 ## 4. Building for MacOS
 115
 116 It is assumed that the DALi environment has been set up & that DALi Core has been built accordingly.
 117
 118 To build the repository enter the 'build/tizen' folder:
 119 ```zsh
 120 % cd dali-adaptor/build/tizen
 121 ```
 122 Then run the following command to set up the build:
 123 ```zsh
 124 % cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_TOOLCHAIN_FILE=$VCPKG_FOLDER/scripts/buildsystems/vcpkg.cmake -DINSTALL_CMAKE_MODULES=ON -DENABLE_PROFILE=MACOS -DPROFILE_LCASE=macos
 125 ```
 126 If a Debug build is required, then add `-DCMAKE_BUILD_TYPE=Debug -DENABLE_DEBUG=ON`
 127
 128 To build, run:
 129 ```zsh
 130 % make install -j8
 131 ```