Removed memcpy() from uniform write
[platform/core/uifw/dali-core.git] / README.md
index 2e4166c..3395a03 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,15 +7,17 @@
          * [Minimum Requirements](#minimum-requirements)
          * [Creating a DALi Environment](#creating-a-dali-environment)
          * [Building the Repository](#building-the-repository)
-         * [Build target options](#build-target-options)
          * [Building and executing test cases](#building-and-executing-test-cases)
       * [2. GBS Builds](#2-gbs-builds)
          * [NON-SMACK Targets](#non-smack-targets)
          * [SMACK enabled Targets](#smack-enabled-targets)
          * [DEBUG Builds](#debug-builds)
-      * [3. Building DALi as Javascript using Emscripten](#3-building-dali-as-javascript-using-emscripten)
-         * [Environment for Emscripten Javascript builds](#environment-for-emscripten-javascript-builds)
-         * [Building the repository as Javascript using Emscripten](#building-the-repository-as-javascript-using-emscripten)
+      * [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)
+         * [macOS Dependencies](#macos-dependencies)
+         * [Build the repository](#build-the-repository)
 
 # Build Instructions
 
 
 ### Minimum Requirements
 
- - Ubuntu 14.04 or later
+ - Ubuntu 16.04 or later
+ - GCC version 9
+ - Cmake version 3.8.2 or later
+
+DALi requires a compiler supporting C++17 features.
 
 ### Creating a DALi Environment
 
@@ -58,26 +64,15 @@ To build the repository enter the 'build/tizen' folder:
 
          $ cd dali-core/build/tizen
 
-Then run the following commands:
-
-         $ autoreconf --install
-         $ ./configure --prefix=$DESKTOP_PREFIX
-         $ make install -j8
-
-### Build target options
-
-OpenGL ES context:
+Then run the following command to set up the build:
 
-When building, the OpenGL ES version of the target should be specified.
+         $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX .
 
-Valid version options are 20, 30, 31
+If a Debug build is required, then add -DCMAKE_BUILD_TYPE=Debug
 
-With configure:
-Add: *--enable-gles=X*
-
-With gbs:
-Add to the gbs build line: *--define "%target_gles_version X"*
+To build run:
 
+         $ make install -j8
 
 ### Building and executing test cases
 
@@ -97,47 +92,76 @@ See the README.md in dali-core/automated-tests.
 
          $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
 
-## 3. Building DALi as Javascript using Emscripten
+## 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.
 
+- Download the windows-dependencies repository from DaliHub
 
-### Environment for Emscripten Javascript builds
+         $ git clone https://github.com/dalihub/windows-dependencies.git
 
-To build the Javascript version of DALi, the Emscripten SDK is required.
-Installation of this is built in to the main dali_env script.
+- Read the windows-dependencies/vcpkg-script/Readme.md file for more instructions on how to build and install the third-party dependencies.
 
-First create a directory for the environment:
+### 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.
 
-         $ mkdir -p ~/dali-env-emscripten
+### Build with CMake
 
-Now run the dali_env script. This will download and build the Emscripten SDK, which may take several minutes.
-The script may ask for your password as it will need to install any package prerequisites.
-Note the "-e" option for Emscripten.
+  * Requirements
+    It's required the version 3.12.2 of CMake and a Git Bash Shell.
 
-         $ cd ~/dali-env-emscripten
-         $ PATH-TO-DALI-CORE/build/scripts/dali_env -c -e
+  * 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.
 
-Create the setenv script. A new section for Emscripten will be created at the top.
+  * Define an environment variable to set the path to the VCPKG folder
 
-         $ ./dali-env/opt/bin/dali_env -s > setenv
+    $ export VCPKG_FOLDER=C:/Users/username/Workspace/VCPKG_TOOL
 
-Run the setenv script to setup environment variables.
+  * Define an environment variable to set the path where DALi is going to be installed.
 
-         $ . ./setenv
+    $ export DALI_ENV_FOLDER=C:/Users/username/Workspace/dali-env
 
-Warning: As of 19/01/2015 with a userID > 6 digits there was a bug in llvm that caused
-the build to fail. So I've used the incoming branches of the emscripten sdk and not latest.
+  * Execute the following commands to create the makefiles, build and install DALi.
 
-### Building the repository as Javascript using Emscripten
+    $ 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
+    $ cmake --build . --target install
 
-Clean the build first:
 
-         $ cd ./dali-core/build/tizen
-         $ git clean -dxf
-         $ autoreconf --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).
+    - ENABLE_DEBUG          ---> Whether to build with debug enabled.
 
-Use llvm's drop in replacements for configure & make:
+## 4. Building for macOS
 
-         $ emconfigure ./configure --verbose --prefix=$DESKTOP_PREFIX --enable-emscripten=yes --enable-debug=yes --enable-profile=UBUNTU --enable-gles=20
-         $ emmake make install -j8
+### macOS Dependencies
 
+Ensure you have followed the instructions in the macos-dependencies repo [here](https://github.com/dalihub/macos-dependencies)
+to create the DALi environment on the macOS.
+You can clone it using:
+```zsh
+% git clone https://github.com/dalihub/macos-dependencies.git
+```
 
+### Build the repository
+
+To build the repository enter the 'build/tizen' folder:
+```zsh
+% cd dali-core/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
+```
+If a Debug build is required, then add `-DCMAKE_BUILD_TYPE=Debug -DENABLE_DEBUG=ON`
+
+To build run:
+```zsh
+% make install -j8
+```