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