Merge branch 'devel/master' into tizen
[platform/core/uifw/dali-demo.git] / README.md
index d154302..6792332 100644 (file)
--- a/README.md
+++ b/README.md
          * [NON-SMACK Targets](#non-smack-targets)
          * [SMACK enabled Targets](#smack-enabled-targets)
          * [DEBUG Builds](#debug-builds-1)
+      * [3. Building for Android](#3-android-builds)
+      * [4. Building for MS Windows](#4-windows-builds)
+         * Build with the Visual Studio project.
+         * Build with CMake.
    * [Creating an example](#creating-an-example)
 
 # Build Instructions
 
  - Ubuntu 16.04 or later
  - Environment created using dali_env script in dali-core repository
- - GCC version 6
+ - GCC version 9
+ - Cmake version 3.8.2 or later
 
-DALi requires a compiler supporting C++11 features.
-Ubuntu 16.04 is the first version to offer this by default (GCC v5.4.0).
-
-GCC version 6 is recommended since it has fixes for issues in version 5
-e.g. it avoids spurious 'defined but not used' warnings in header files.
+DALi requires a compiler supporting C++17 features.
 
 ### Building the Repository
 
@@ -77,10 +78,12 @@ Before running make install as normal:
 ### Requirements
 
  - Ubuntu 16.04 or later
- - GCC version 6
+ - Android DALi dependencies
+ - If you are behind a proxy, please set up the "http_proxy" and "https_proxy" environment variables appropriately
+ - Clone dali-core, dali-adaptor, dali-toolkit & android-dependencies to the same folder as dali-demo
+   - Android dependencies can be cloned from: https://github.com/dalihub/android-dependencies
 
 ### Building the Repository
-
 To build the repository enter the 'build/android' folder:
 
          $ cd dali-demo/build/android
@@ -93,6 +96,11 @@ For debug build:
 
          $ DEBUG=1 ./build.sh
 
+To debug from Android Studio set Android DALi enviroment using setenv script in 'build/android' and launch Android Studio from the enviroment:
+
+         $ . setenv
+         $ <path/to/androidstudio>/bin/studio.sh
+
 To clean the build:
 
          $ ./build.sh clean
@@ -102,3 +110,56 @@ To install apks:
          $ adb install -r ./app/build/outputs/apk/debug/dali-demo-debug.apk
          $ adb install -r ./app/build/outputs/apk/release/dali-demo-release.apk
 
+## 4. Building for MS Windows
+
+Third party dependencies are built using vcpkg. Instructions on how to install vcpkg can be found in the
+vcpkg-script folder in the windows-dependencies repository.
+
+- Download the windows-dependencies repository from DaliHub
+
+         $ git clone https://github.com/dalihub/windows-dependencies.git
+
+- Read the windows-dependencies/vcpkg-script/Readme.md file for more instructions on how to build and install the third-party dependencies.
+
+### Build with the Visual Studio project
+  Read the windows-dependencies/README.md file for more instructions on how to build and run DALi for MS Windows.
+
+### Build with CMake
+
+  * Requirements
+    It's required the version 3.12.2 of CMake and a Git Bash Shell.
+
+  * Notes and troubleshoting:
+    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.
+    However, the CMake version installed with MS Visual Studio 2017 is a bit out of date and some VCPKG modules require a higher version.
+    This instructions have been tested with CMake 3.12.2 on a Git Bash shell.
+
+  * Define an environment variable to set the path to the VCPKG folder
+
+    $ export VCPKG_FOLDER=C:/Users/username/Workspace/VCPKG_TOOL
+
+  * Define an environment variable to set the path where DALi is going to be installed.
+
+    $ export DALI_ENV_FOLDER=C:/Users/username/Workspace/dali-env
+
+  * Execute the following commands to create the makefiles, build and install DALi.
+
+    $ 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
+    $ cmake --build . --target install
+
+  * Options:
+    - CMAKE_TOOLCHAIN_FILE  ---> Needed to find packages installed by VCPKG.
+    - ENABLE_PKG_CONFIGURE  ---> Whether to install pkg configure files (not currently working on MS Windows. CMake modules used instead).
+    - INTERNATIONALIZATION  ---> Whether to generate and install internazionalization '.po' Portable Object files.
+    - CMAKE_INSTALL_PREFIX  ---> Were DALi is installed.
+    - ENABLE_DEBUG          ---> Whether to build with debug enabled.
+
+  * 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.
+
+    i.e
+    $ setx DALI_ENV_FOLDER C:/Users/username/dali-env
+    $ setx DALI_IMAGE_DIR $DALI_ENV_FOLDER/share/dali/toolkit/images/
+    $ setx DALI_SOUND_DIR $DALI_ENV_FOLDER/share/dali/toolkit/sounds/
+    $ setx DALI_STYLE_DIR $DALI_ENV_FOLDER/share/dali/toolkit/styles/
+    $ setx DALI_STYLE_IMAGE_DIR $DALI_ENV_FOLDER/share/dali/toolkit/styles/images/
+    $ setx DALI_DATA_READ_ONLY_DIR $DALI_ENV_FOLDER/share/dali/