Merge "CanvasRenderer:: Add Picture class" into devel/master
[platform/core/uifw/dali-adaptor.git] / README.md
index 1a5642e..42afb8d 100644 (file)
--- a/README.md
+++ b/README.md
          * [Building and executing test cases](#building-and-executing-test-cases)
       * [2. GBS Builds](#2-gbs-builds)
          * [DEBUG Builds](#debug-builds)
-      * [3. Building for Emscripten](#3-building-for-emscripten)
-         * [Setup dali-env & build dali-core](#setup-dali-env--build-dali-core)
-         * [Build the minimal dali-adaptor](#build-the-minimal-dali-adaptor)
-         * [Using the Javascript Build](#using-the-javascript-build)
+      * [3. Building for MS Windows](#3-building-for-ms-windows)
+         * Build with the Visual Studio project.
+         * Build with CMake.
+      * [4. Building for MacOS](#4-building-for-macos)
 
 # Build Instructions
 
 
 ### Minimum Requirements
 
- - Ubuntu 14.04 or later
+ - Ubuntu 16.04 or later
  - Environment created using dali_env script in dali-core repository
+ - GCC version 9
+ - Cmake version 3.8.2 or later
+
+DALi requires a compiler supporting C++17 features.
 
 ### Building the Repository
 
@@ -30,25 +34,15 @@ To build the repository enter the 'build/tizen' folder:
 
          $ cd dali-adaptor/build/tizen
 
-Then run the following commands:
-
-         $ autoreconf --install
-         $ /configure --prefix=$DESKTOP_PREFIX
-         $ make install -j8
-
-### Build target options
+Then run the following command to set up the build:
 
-OpenGL ES context:
+         $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX .
 
-When building, the OpenGL ES version of the target should be specified.
+If a Debug build is required, then add -DCMAKE_BUILD_TYPE=Debug
 
-Valid version options are 20, 30, 31 for OpenGL ES versions 2.0, 3.0 and 3.1 respectively.
+To build run:
 
-With configure:
-Add: *--enable-gles=X*
-
-With gbs:
-Add to the gbs build line: *--define "%target_gles_version X"*
+         $ make install -j8
 
 ### Building and executing test cases
 
@@ -62,33 +56,68 @@ See the README.md in dali-adaptor/automated-tests.
 
          $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
 
-## 3. Building for Emscripten
 
-Currently the build for emscripten uses a minimal adaptor which does not support dali-toolkit.
+## 3. 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.
 
-### Setup dali-env & build dali-core
+- Download the windows-dependencies repository from DaliHub
 
- The build requires the Emscripten SDK, this is installed automatically by running dali_env with the correct parameters.
- dali_env is part of the dali-core repository.
- Please see the README within dali-core to setup dali_env and build dali-core.
+         $ git clone https://github.com/dalihub/windows-dependencies.git
 
-### Build the minimal dali-adaptor
+- Read the windows-dependencies/vcpkg-script/Readme.md file for more instructions on how to build and install the third-party dependencies.
 
-  Use the build.sh script build adaptor.
-  This uses emscriptens emcc to compile byte code to javascript (full OpenGL ES support with stb-image loading library and cpp bindings).
-  Note: Please view the build.sh script for debug build options.
+### 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.
 
-         $ # cd ./build/emscripten
-         $ # ./build.sh
+### Build with CMake
 
-### Using the Javascript Build
+  * Requirements
+    It's required the version 3.12.2 of CMake and a Git Bash Shell.
 
- The build will create 1 main Javascript artifact, and its html counterpart; dali-emscripten.js
+  * 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.
 
- This is required by any dali JS app, and must be located in the same directory as the app JS in order for the browser to find it.
+  * Define an environment variable to set the path to the VCPKG folder
 
- After the build, the necessary artifacts (which include dali-wrapper.js) will be placed in the dali-env directory under opt/share/emscripten:
+    $ export VCPKG_FOLDER=C:/Users/username/Workspace/VCPKG_TOOL
 
- dali-env/opt/share/emscripten
+  * Define an environment variable to set the path where DALi is going to be installed.
 
- If dali-demo is built, any JS examples will also be placed in this directory, so they are ready to run.
+    $ 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 -DENABLE_LINK_TEST=OFF -DCMAKE_INSTALL_PREFIX=$DALI_ENV_FOLDER -DINSTALL_CMAKE_MODULES=ON -DPROFILE_LCASE=windows
+    $ 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).
+    - ENABLE_LINK_TEST      ---> Whether to enable the link test (not currently working on MS Windows).
+    - CMAKE_INSTALL_PREFIX  ---> Were DALi is installed.
+    - INSTALL_CMAKE_MODULES ---> Whether to install the CMake modules (Used by the CMake command find_package() to find previously installed libraries).
+    - PROFILE_LCASE         ---> The platform (must be windows).
+    - ENABLE_DEBUG          ---> Whether to build with debug enabled.
+
+## 4. Building for MacOS
+
+It is assumed that the DALi environment has been set up & that DALi Core has been built accordingly.
+
+To build the repository enter the 'build/tizen' folder:
+```zsh
+% cd dali-adaptor/build/tizen
+```
+Then run the following command to set up the build:
+```zsh
+% cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_TOOLCHAIN_FILE=$VCPKG_FOLDER/scripts/buildsystems/vcpkg.cmake -DINSTALL_CMAKE_MODULES=ON -DENABLE_PROFILE=MACOS -DPROFILE_LCASE=macos
+```
+If a Debug build is required, then add `-DCMAKE_BUILD_TYPE=Debug -DENABLE_DEBUG=ON`
+
+To build, run:
+```zsh
+% make install -j8
+```