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          * [Build target options](#build-target-options)
  11          * [Building and executing test cases](#building-and-executing-test-cases)
  12       * [2. GBS Builds](#2-gbs-builds)
  13          * [NON-SMACK Targets](#non-smack-targets)
  14          * [SMACK enabled Targets](#smack-enabled-targets)
  15          * [DEBUG Builds](#debug-builds)
  16       * [3. Building for MS Windows](#3-building-for-ms-windows)
  17
  18 # Build Instructions
  19
  20 ## 1. Building for Ubuntu desktop
  21
  22 ### Requirements
  23
  24  - Ubuntu 14.04 or later
  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
  34 ### Creating a DALi Environment
  35
  36 To build for desktop first ensure ALL sources are selected:
  37  - Go to Ubuntu Settings and then to "Software & Updates"
  38  - In the "Ubuntu Software" tab, ensure ALL software sources are ticked
  39
  40 (This is required because we install some community-maintained free & open-source software)
  41
  42 Then you can create a dali-env folder in your home folder with:
  43
  44          $ dali-core/build/scripts/dali_env -c
  45
  46 This will also download any dependencies that the dali repositories require.
  47
  48 You can save the environment variables to a file:
  49
  50          $ dali-env/opt/bin/dali_env -s > setenv
  51
  52 This process only needs to be done once.
  53
  54 Next source these variables:
  55
  56          $ . setenv
  57
  58 You will have to source these variables every time you open up a new terminal (or you can add to .bashrc if you prefer).
  59
  60
  61 ### Building the Repository
  62
  63 To build the repository enter the 'build/tizen' folder:
  64
  65          $ cd dali-core/build/tizen
  66
  67 Then run the following command to set up the build:
  68
  69          $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX .
  70
  71 If a Debug build is required, then add -DCMAKE_BUILD_TYPE=Debug
  72
  73 To build run:
  74
  75          $ make install -j8
  76
  77 ### Building and executing test cases
  78
  79 See the README.md in dali-core/automated-tests.
  80
  81 ## 2. GBS Builds
  82
  83 ### NON-SMACK Targets
  84
  85          $ gbs build -A [TARGET_ARCH]
  86
  87 ### SMACK enabled Targets
  88
  89          $ gbs build -A [TARGET_ARCH] --define "%enable_dali_smack_rules 1"
  90
  91 ### DEBUG Builds
  92
  93          $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
  94
  95 ## 3. Building for MS Windows
  96
  97 Third party dependencies are built using vcpkg. Instructions on how to install vcpkg can be found in the
  98 vcpkg-script folder in the windows-dependencies repository.
  99
 100 - Download the windows-dependencies repository from DaliHub
 101
 102          $ git clone https://github.com/dalihub/windows-dependencies.git
 103
 104 - Read the README.md and vcpkg-script/Readme.md files for more instructions on how to install and build the third-party dependencies.