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
  17 # Build Instructions
  18
  19 ## 1. Building for Ubuntu desktop
  20
  21 ### Minimum Requirements
  22
  23  - Ubuntu 14.04 or later
  24  - Environment created using dali_env script in dali-core repository
  25  - GCC version 6
  26
  27 DALi requires a compiler supporting C++11 features.
  28 Ubuntu 16.04 is the first version to offer this by default (GCC v5.4.0).
  29
  30 GCC version 6 is recommended since it has fixes for issues in version 5
  31 e.g. it avoids spurious 'defined but not used' warnings in header files.
  32
  33 ### Building the Repository
  34
  35 To build the repository enter the 'build/tizen' folder:
  36
  37          $ cd dali-adaptor/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-adaptor/automated-tests.
  52
  53 ## 2. GBS Builds
  54
  55          $ gbs build -A [TARGET_ARCH]
  56
  57 ### DEBUG Builds
  58
  59          $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
  60
  61
  62 ## 3. Building for MS Windows
  63
  64 Third party dependencies are built using vcpkg. Instructions on how to install vcpkg can be found in the
  65 vcpkg-script folder in the windows-dependencies repository.
  66
  67 - Download the windows-dependencies repository from DaliHub
  68
  69          $ git clone https://github.com/dalihub/windows-dependencies.git
  70
  71 - Read the windows-dependencies/vcpkg-script/Readme.md file for more instructions on how to build and install the third-party dependencies.
  72
  73 ### Build with the Visual Studio project
  74   Read the windows-dependencies/README.md file for more instructions on how to build and run DALi for MS Windows.
  75
  76 ### Build with CMake
  77
  78   * Requirements
  79     It's required the version 3.12.2 of CMake and a Git Bash Shell.
  80
  81   * Notes and troubleshoting:
  82     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.
  83     However, the CMake version installed with MS Visual Studio 2017 is a bit out of date and some VCPKG modules require a higher version.
  84     This instructions have been tested with CMake 3.12.2 on a Git Bash shell.
  85
  86   * Define an environment variable to set the path to the VCPKG folder
  87
  88     $ export VCPKG_FOLDER=C:/Users/username/Workspace/VCPKG_TOOL
  89
  90   * Define an environment variable to set the path where DALi is going to be installed.
  91
  92     $ export DALI_ENV_FOLDER=C:/Users/username/Workspace/dali-env
  93
  94   * Execute the following commands to create the makefiles, build and install DALi.
  95
  96     $ 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
  97     $ cmake --build . --target install
  98
  99   * Options:
 100     - CMAKE_TOOLCHAIN_FILE  ---> Needed to find packages installed by VCPKG.
 101     - ENABLE_PKG_CONFIGURE  ---> Whether to install pkg configure files (not currently working on MS Windows. CMake modules used instead).
 102     - ENABLE_LINK_TEST      ---> Whether to enable the link test (not currently working on MS Windows).
 103     - CMAKE_INSTALL_PREFIX  ---> Were DALi is installed.
 104     - INSTALL_CMAKE_MODULES ---> Whether to install the CMake modules (Used by the CMake command find_package() to find previously installed libraries).
 105     - PROFILE_LCASE         ---> The platform (must be windows).
 106     - ENABLE_DEBUG          ---> Whether to build with debug enabled.