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          * [Creating a DALi Environment](#creating-a-dali-environment)
   9          * [Building the Repository](#building-the-repository)
  10          * [Building and executing test cases](#building-and-executing-test-cases)
  11       * [2. GBS Builds](#2-gbs-builds)
  12          * [NON-SMACK Targets](#non-smack-targets)
  13          * [SMACK enabled Targets](#smack-enabled-targets)
  14          * [DEBUG Builds](#debug-builds)
  15       * [3. Building for MS Windows](#3-building-for-ms-windows)
  16          * Build with the Visual Studio project.
  17          * Build with CMake.
  18
  19 # Build Instructions
  20
  21 ## 1. Building for Ubuntu desktop
  22
  23 ### Minimum Requirements
  24
  25  - Ubuntu 14.04 or later
  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
  35 ### Creating a DALi Environment
  36
  37 To build for desktop first ensure ALL sources are selected:
  38  - Go to Ubuntu Settings and then to "Software & Updates"
  39  - In the "Ubuntu Software" tab, ensure ALL software sources are ticked
  40
  41 (This is required because we install some community-maintained free & open-source software)
  42
  43 Then you can create a dali-env folder in your home folder with:
  44
  45          $ dali-core/build/scripts/dali_env -c
  46
  47 This will also download any dependencies that the dali repositories require.
  48
  49 You can save the environment variables to a file:
  50
  51          $ dali-env/opt/bin/dali_env -s > setenv
  52
  53 This process only needs to be done once.
  54
  55 Next source these variables:
  56
  57          $ . setenv
  58
  59 You will have to source these variables every time you open up a new terminal (or you can add to .bashrc if you prefer).
  60
  61
  62 ### Building the Repository
  63
  64 To build the repository enter the 'build/tizen' folder:
  65
  66          $ cd dali-core/build/tizen
  67
  68 Then run the following command to set up the build:
  69
  70          $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX .
  71
  72 If a Debug build is required, then add -DCMAKE_BUILD_TYPE=Debug
  73
  74 To build run:
  75
  76          $ make install -j8
  77
  78 ### Building and executing test cases
  79
  80 See the README.md in dali-core/automated-tests.
  81
  82 ## 2. GBS Builds
  83
  84 ### NON-SMACK Targets
  85
  86          $ gbs build -A [TARGET_ARCH]
  87
  88 ### SMACK enabled Targets
  89
  90          $ gbs build -A [TARGET_ARCH] --define "%enable_dali_smack_rules 1"
  91
  92 ### DEBUG Builds
  93
  94          $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
  95
  96 ## 3. Building for MS Windows
  97
  98 Third party dependencies are built using vcpkg. Instructions on how to install vcpkg can be found in the
  99 vcpkg-script folder in the windows-dependencies repository.
 100
 101 - Download the windows-dependencies repository from DaliHub
 102
 103          $ git clone https://github.com/dalihub/windows-dependencies.git
 104
 105 - Read the windows-dependencies/vcpkg-script/Readme.md file for more instructions on how to build and install the third-party dependencies.
 106
 107 ### Build with the Visual Studio project
 108   Read the windows-dependencies/README.md file for more instructions on how to build and run DALi for MS Windows.
 109
 110 ### Build with CMake
 111
 112   * Requirements
 113     It's required the version 3.12.2 of CMake and a Git Bash Shell.
 114
 115   * Notes and troubleshoting:
 116     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.
 117     However, the CMake version installed with MS Visual Studio 2017 is a bit out of date and some VCPKG modules require a higher version.
 118     This instructions have been tested with CMake 3.12.2 on a Git Bash shell.
 119
 120   * Define an environment variable to set the path to the VCPKG folder
 121
 122     $ export VCPKG_FOLDER=C:/Users/username/Workspace/VCPKG_TOOL
 123
 124   * Define an environment variable to set the path where DALi is going to be installed.
 125
 126     $ export DALI_ENV_FOLDER=C:/Users/username/Workspace/dali-env
 127
 128   * Execute the following commands to create the makefiles, build and install DALi.
 129
 130     $ 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
 131     $ cmake --build . --target install
 132
 133
 134   * Options:
 135     - CMAKE_TOOLCHAIN_FILE  ---> Needed to find packages installed by VCPKG.
 136     - ENABLE_PKG_CONFIGURE  ---> Whether to install pkg configure files (not currently working on MS Windows. CMake modules used instead).
 137     - ENABLE_LINK_TEST      ---> Whether to enable the link test (not currently working on MS Windows).
 138     - CMAKE_INSTALL_PREFIX  ---> Were DALi is installed.
 139     - INSTALL_CMAKE_MODULES ---> Whether to install the CMake modules (Used by the CMake command find_package() to find previously installed libraries).
 140     - ENABLE_DEBUG          ---> Whether to build with debug enabled.