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       * [4. Building for macOS](#4-building-for-macos)
  19          * [macOS Dependencies](#macos-dependencies)
  20          * [Build the repository](#build-the-repository)
  21
  22 # Build Instructions
  23
  24 ## 1. Building for Ubuntu desktop
  25
  26 ### Minimum Requirements
  27
  28  - Ubuntu 16.04 or later
  29  - GCC version 9
  30  - Cmake version 3.8.2 or later
  31
  32 DALi requires a compiler supporting C++17 features.
  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 windows-dependencies/vcpkg-script/Readme.md file for more instructions on how to build and install the third-party dependencies.
 105
 106 ### Build with the Visual Studio project
 107   Read the windows-dependencies/README.md file for more instructions on how to build and run DALi for MS Windows.
 108
 109 ### Build with CMake
 110
 111   * Requirements
 112     It's required the version 3.12.2 of CMake and a Git Bash Shell.
 113
 114   * Notes and troubleshoting:
 115     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.
 116     However, the CMake version installed with MS Visual Studio 2017 is a bit out of date and some VCPKG modules require a higher version.
 117     This instructions have been tested with CMake 3.12.2 on a Git Bash shell.
 118
 119   * Define an environment variable to set the path to the VCPKG folder
 120
 121     $ export VCPKG_FOLDER=C:/Users/username/Workspace/VCPKG_TOOL
 122
 123   * Define an environment variable to set the path where DALi is going to be installed.
 124
 125     $ export DALI_ENV_FOLDER=C:/Users/username/Workspace/dali-env
 126
 127   * Execute the following commands to create the makefiles, build and install DALi.
 128
 129     $ 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
 130     $ cmake --build . --target install
 131
 132
 133   * Options:
 134     - CMAKE_TOOLCHAIN_FILE  ---> Needed to find packages installed by VCPKG.
 135     - ENABLE_PKG_CONFIGURE  ---> Whether to install pkg configure files (not currently working on MS Windows. CMake modules used instead).
 136     - ENABLE_LINK_TEST      ---> Whether to enable the link test (not currently working on MS Windows).
 137     - CMAKE_INSTALL_PREFIX  ---> Were DALi is installed.
 138     - INSTALL_CMAKE_MODULES ---> Whether to install the CMake modules (Used by the CMake command find_package() to find previously installed libraries).
 139     - ENABLE_DEBUG          ---> Whether to build with debug enabled.
 140
 141 ## 4. Building for macOS
 142
 143 ### macOS Dependencies
 144
 145 Ensure you have followed the instructions in the macos-dependencies repo [here](https://github.com/dalihub/macos-dependencies)
 146 to create the DALi environment on the macOS.
 147 You can clone it using:
 148 ```zsh
 149 % git clone https://github.com/dalihub/macos-dependencies.git
 150 ```
 151
 152 ### Build the repository
 153
 154 To build the repository enter the 'build/tizen' folder:
 155 ```zsh
 156 % cd dali-core/build/tizen
 157 ```
 158 Then run the following command to set up the build:
 159 ```zsh
 160 % cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_TOOLCHAIN_FILE=$VCPKG_FOLDER/scripts/buildsystems/vcpkg.cmake -DINSTALL_CMAKE_MODULES=ON
 161 ```
 162 If a Debug build is required, then add `-DCMAKE_BUILD_TYPE=Debug -DENABLE_DEBUG=ON`
 163
 164 To build run:
 165 ```zsh
 166 % make install -j8
 167 ```