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          * [DEBUG Builds](#debug-builds)
  10       * [2. GBS Builds](#2-gbs-builds)
  11          * [NON-SMACK Targets](#non-smack-targets)
  12          * [SMACK enabled Targets](#smack-enabled-targets)
  13          * [DEBUG Builds](#debug-builds-1)
  14       * [3. Building for Android](#3-android-builds)
  15       * [4. Building for MS Windows](#4-windows-builds)
  16          * Build with the Visual Studio project.
  17          * Build with CMake.
  18       * [5. Building for MacOS](#5-building-for-macos)
  19    * [Creating an example](#creating-an-example)
  20
  21 # Build Instructions
  22
  23 ## 1. Building for Ubuntu desktop
  24
  25 ### Requirements
  26
  27  - Ubuntu 16.04 or later
  28  - Environment created using dali_env script in dali-core repository
  29  - GCC version 9
  30  - Cmake version 3.8.2 or later
  31
  32 DALi requires a compiler supporting C++17 features.
  33
  34 ### Building the Repository
  35
  36 To build the repository enter the 'build/tizen' folder:
  37
  38          $ cd dali-demo/build/tizen
  39
  40 Then run the following commands:
  41
  42          $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX .
  43          $ make install -j8
  44
  45 ### DEBUG Builds
  46
  47 Specify a debug build when building for desktop by passing the following parameter to cmake:
  48
  49          $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_BUILD_TYPE=Debug .
  50
  51 Before running make install as normal:
  52
  53          $ make install -j8
  54
  55 ### Build Only specific sample
  56
  57 You can set the sample's name and can build that sample only. For example, If you want to build 'hello-world',
  58
  59          $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DBUILD_EXAMPLE_NAME=hello-world
  60          $ make install -j9
  61
  62 ## 2. GBS Builds
  63
  64 ### NON-SMACK Targets
  65
  66          $ gbs build -A [TARGET_ARCH]
  67
  68 ### SMACK enabled Targets
  69
  70          $ gbs build -A [TARGET_ARCH] --define "%enable_dali_smack_rules 1"
  71
  72 ### DEBUG Builds
  73
  74          $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
  75
  76 ### Raspberry Pi builds
  77
  78          $ gbs build -A [TARGET_ARCH] --define "%rpi_style 1"
  79
  80 ### Build specific sample only
  81
  82          $ gbs build -A [TARGET_ARCH] --define "build_example_name hello-world"
  83
  84 # Creating an example
  85
  86  - Make a directory in the "examples" directory. Only one example will be created per directory.
  87  - The executable installed will have a ".example" appended to it, e.g. a "blocks" directory produces "blocks.example".
  88  - Add all source files for the required example in this directory.
  89  - Modify "com.samsung.dali-demo.xml" to include your example so that it can be launched on target.
  90  - No changes are required to the make system as long as the above is followed, your example will be automatically built & installed.
  91
  92 ## 3. Building for Android
  93
  94 ### Requirements
  95
  96  - Ubuntu 16.04 or later
  97  - Android DALi dependencies
  98  - If you are behind a proxy, please set up the "http_proxy" and "https_proxy" environment variables appropriately
  99  - Clone dali-core, dali-adaptor, dali-toolkit & android-dependencies to the same folder as dali-demo
 100    - Android dependencies can be cloned from: https://github.com/dalihub/android-dependencies
 101
 102 ### Building the Repository
 103 To build the repository enter the 'build/android' folder:
 104
 105          $ cd dali-demo/build/android
 106
 107 Then run the following command:
 108
 109          $ ./build.sh
 110
 111 For debug build:
 112
 113          $ DEBUG=1 ./build.sh
 114
 115 To debug from Android Studio set Android DALi enviroment using setenv script in 'build/android' and launch Android Studio from the enviroment:
 116
 117          $ . setenv
 118          $ <path/to/androidstudio>/bin/studio.sh
 119
 120 To clean the build:
 121
 122          $ ./build.sh clean
 123
 124 To install apks:
 125
 126          $ adb install -r ./app/build/outputs/apk/debug/dali-demo-debug.apk
 127          $ adb install -r ./app/build/outputs/apk/release/dali-demo-release.apk
 128
 129 Manually granting permission for accessing Storage before running the demo
 130          1. Long press the DALi demo app icon => App Info
 131          2. Permissions => Storage => Enable
 132
 133 ## 4. Building for MS Windows
 134
 135 Third party dependencies are built using vcpkg. Instructions on how to install vcpkg can be found in the
 136 vcpkg-script folder in the windows-dependencies repository.
 137
 138 - Download the windows-dependencies repository from DaliHub
 139
 140          $ git clone https://github.com/dalihub/windows-dependencies.git
 141
 142 - Read the windows-dependencies/vcpkg-script/Readme.md file for more instructions on how to build and install the third-party dependencies.
 143
 144 ### Build with the Visual Studio project
 145   Read the windows-dependencies/README.md file for more instructions on how to build and run DALi for MS Windows.
 146
 147 ### Build with CMake
 148
 149   * Requirements
 150     It's required the version 3.12.2 of CMake and a Git Bash Shell.
 151
 152   * Notes and troubleshoting:
 153     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.
 154     However, the CMake version installed with MS Visual Studio 2017 is a bit out of date and some VCPKG modules require a higher version.
 155     This instructions have been tested with CMake 3.12.2 on a Git Bash shell.
 156
 157   * Define an environment variable to set the path to the VCPKG folder
 158
 159     $ export VCPKG_FOLDER=C:/Users/username/Workspace/VCPKG_TOOL
 160
 161   * Define an environment variable to set the path where DALi is going to be installed.
 162
 163     $ export DALI_ENV_FOLDER=C:/Users/username/Workspace/dali-env
 164
 165   * Execute the following commands to create the makefiles, build and install DALi.
 166
 167     $ cmake -g Ninja . -DCMAKE_TOOLCHAIN_FILE=$VCPKG_FOLDER/vcpkg/scripts/buildsystems/vcpkg.cmake -DENABLE_PKG_CONFIGURE=OFF -DINTERNATIONALIZATION=OFF -DCMAKE_INSTALL_PREFIX=$DALI_ENV_FOLDER
 168     $ cmake --build . --target install
 169
 170   * Options:
 171     - CMAKE_TOOLCHAIN_FILE  ---> Needed to find packages installed by VCPKG.
 172     - ENABLE_PKG_CONFIGURE  ---> Whether to install pkg configure files (not currently working on MS Windows. CMake modules used instead).
 173     - INTERNATIONALIZATION  ---> Whether to generate and install internazionalization '.po' Portable Object files.
 174     - CMAKE_INSTALL_PREFIX  ---> Were DALi is installed.
 175     - ENABLE_DEBUG          ---> Whether to build with debug enabled.
 176     - BUILD_EXAMPLE_NAME    ---> The name of sample what you want to build. To reduce the memory of rpm file, we didn't copy resources now.
 177
 178   * If dali-toolkit has been compiled with the USE_DEFAULT_RESOURCE_DIR option disabled then is needed to set global environment variables in order to find the default toolkit resources.
 179
 180     i.e
 181     $ setx DALI_ENV_FOLDER C:/Users/username/dali-env
 182     $ setx DALI_IMAGE_DIR $DALI_ENV_FOLDER/share/dali/toolkit/images/
 183     $ setx DALI_SOUND_DIR $DALI_ENV_FOLDER/share/dali/toolkit/sounds/
 184     $ setx DALI_STYLE_DIR $DALI_ENV_FOLDER/share/dali/toolkit/styles/
 185     $ setx DALI_STYLE_IMAGE_DIR $DALI_ENV_FOLDER/share/dali/toolkit/styles/images/
 186     $ setx DALI_DATA_READ_ONLY_DIR $DALI_ENV_FOLDER/share/dali/
 187
 188 ## 5. Building for MacOS
 189
 190 It is assumed that the DALi environment has been set up & that DALi Core, Adaptor & Toolkit have been built accordingly.
 191
 192 To build the repository enter the 'build/tizen' folder:
 193 ```zsh
 194 % cd dali-demo/build/tizen
 195 ```
 196 Then run the following command to set up the build:
 197 ```zsh
 198 % cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_TOOLCHAIN_FILE=$VCPKG_FOLDER/scripts/buildsystems/vcpkg.cmake -DINTERNATIONALIZATION=OFF
 199 ```
 200 If a Debug build is required, then add `-DCMAKE_BUILD_TYPE=Debug`
 201
 202 To build, run:
 203 ```zsh
 204 % make install -j8
 205 ```
 206
 207 # Creating an example
 208 In the dali-demo/examples folder, add another folder. This will become the name of your example executable, so for example the "hello-world" folder generates a "hello-world.example" binary.
 209 In this folder, you can add as many source code files as you need.
 210
 211 Usually, create a single class file containing a main function that instantiates an Application. Usually, the class is named after your example, followed by "Controller", e.g. hello-world.cpp contains a class called HelloWorldController.
 212
 213 There is a DemoHelper::CreateView method, which enables you to easiliy set up a title bar and buttons.
 214
 215 Add at least a key handler such that Escape or Back keys can be used to quit the application. Some apps that only present a single thing also add a touch handler that quits the application.
 216
 217 Add a launcher line to one of demo/dali-demo.cpp, examples-reel/dali-examples-reel.cpp or tests-reel/dali-tests-reel.cpp, depending on the nature of what you are demonstrating. Generally, dali-demo is for graphical showcase demos, dali-examples-reel is for reasonable examples that look ok, and dali-tests is for examples that are only for testing. This needs a language string defining for the title.
 218
 219 Add 2 lines to shared/dali-demo-strings.h for the title of your application, please keep in alphabetic ordering. Add english strings and translations to each of the language files in resources/po.
 220
 221 To ensure your application can run on a Tizen device through the launcher, add an entry to com.samsung.dali-demo.xml, ensuring that only tabs are used for XML indent.
 222
 223
 224
 225