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 20.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    (This is required because we install some community-maintained free & open-source software)
  40  - Install Perl Recursive support:
  41
  42          $ sudo apt install libfile-copy-recursive-perl
  43
  44 Then you can create a dali-env folder in your home folder with:
  45
  46          $ dali-core/build/scripts/dali_env -c
  47
  48 This will also download any dependencies that the dali repositories require.
  49
  50 You can save the environment variables to a file:
  51
  52          $ dali-env/opt/bin/dali_env -s > setenv
  53
  54 This process only needs to be done once.
  55
  56 Next source these variables:
  57
  58          $ . setenv
  59
  60 You will have to source these variables every time you open up a new terminal (or you can add to .bashrc if you prefer).
  61
  62
  63 ### Building the Repository
  64
  65 To build the repository enter the 'build/tizen' folder:
  66
  67          $ cd dali-core/build/tizen
  68
  69 Then run the following command to set up the build:
  70
  71          $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX .
  72
  73 If a Debug build is required, then add -DCMAKE_BUILD_TYPE=Debug
  74
  75 To build run:
  76
  77          $ make install -j8
  78
  79 ### Building and executing test cases
  80
  81 See the README.md in dali-core/automated-tests.
  82
  83 ## 2. GBS Builds
  84
  85 ### NON-SMACK Targets
  86
  87          $ gbs build -A [TARGET_ARCH]
  88
  89 ### SMACK enabled Targets
  90
  91          $ gbs build -A [TARGET_ARCH] --define "%enable_dali_smack_rules 1"
  92
  93 ### DEBUG Builds
  94
  95          $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
  96
  97 ## 3. Building for MS Windows
  98
  99 Third party dependencies are built using vcpkg. Instructions on how to install vcpkg can be found in the
 100 vcpkg-script folder in the windows-dependencies repository.
 101
 102 - Download the windows-dependencies repository from DaliHub
 103
 104          $ git clone https://github.com/dalihub/windows-dependencies.git
 105
 106 - Read the windows-dependencies/vcpkg-script/Readme.md file for more instructions on how to build and install the third-party dependencies.
 107
 108 ### Build with the Visual Studio project
 109   Read the windows-dependencies/README.md file for more instructions on how to build and run DALi for MS Windows.
 110
 111 ### Build with CMake
 112
 113   * Requirements
 114     It's required the version 3.12.2 of CMake and a Git Bash Shell.
 115
 116   * Notes and troubleshoting:
 117     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.
 118     However, the CMake version installed with MS Visual Studio 2017 is a bit out of date and some VCPKG modules require a higher version.
 119     This instructions have been tested with CMake 3.12.2 on a Git Bash shell.
 120
 121   * Define an environment variable to set the path to the VCPKG folder
 122
 123     $ export VCPKG_FOLDER=C:/Users/username/Workspace/VCPKG_TOOL
 124
 125   * Define an environment variable to set the path where DALi is going to be installed.
 126
 127     $ export DALI_ENV_FOLDER=C:/Users/username/Workspace/dali-env
 128
 129   * Execute the following commands to create the makefiles, build and install DALi.
 130
 131     $ 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
 132     $ cmake --build . --target install
 133
 134
 135   * Options:
 136     - CMAKE_TOOLCHAIN_FILE  ---> Needed to find packages installed by VCPKG.
 137     - ENABLE_PKG_CONFIGURE  ---> Whether to install pkg configure files (not currently working on MS Windows. CMake modules used instead).
 138     - ENABLE_LINK_TEST      ---> Whether to enable the link test (not currently working on MS Windows).
 139     - CMAKE_INSTALL_PREFIX  ---> Were DALi is installed.
 140     - INSTALL_CMAKE_MODULES ---> Whether to install the CMake modules (Used by the CMake command find_package() to find previously installed libraries).
 141     - ENABLE_DEBUG          ---> Whether to build with debug enabled.
 142
 143 ## 4. Building for macOS
 144
 145 ### macOS Dependencies
 146
 147 Ensure you have followed the instructions in the macos-dependencies repo [here](https://github.com/dalihub/macos-dependencies)
 148 to create the DALi environment on the macOS.
 149 You can clone it using:
 150 ```zsh
 151 % git clone https://github.com/dalihub/macos-dependencies.git
 152 ```
 153
 154 ### Build the repository
 155
 156 To build the repository enter the 'build/tizen' folder:
 157 ```zsh
 158 % cd dali-core/build/tizen
 159 ```
 160 Then run the following command to set up the build:
 161 ```zsh
 162 % cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_TOOLCHAIN_FILE=$VCPKG_FOLDER/scripts/buildsystems/vcpkg.cmake -DINSTALL_CMAKE_MODULES=ON
 163 ```
 164 If a Debug build is required, then add `-DCMAKE_BUILD_TYPE=Debug -DENABLE_DEBUG=ON`
 165
 166 To build run:
 167 ```zsh
 168 % make install -j8
 169 ```