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