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