Merge branch 'devel/master' into tizen

[platform/core/uifw/dali-core.git] / README.md

diff --git a/README.md b/README.md
index 97bbf31..37e13ee 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,8 +13,11 @@
          * [SMACK enabled Targets](#smack-enabled-targets)
          * [DEBUG Builds](#debug-builds)
       * [3. Building for MS Windows](#3-building-for-ms-windows)
-         * Build with the Visual Studio project.
-         * Build with CMake.
+         * 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
 
@@ -22,8 +25,9 @@
 
 ### Minimum Requirements
 
- - Ubuntu 16.04 or later
+ - Ubuntu 20.04 or later
  - GCC version 9
+ - Cmake version 3.8.2 or later
 
 DALi requires a compiler supporting C++17 features.
 
@@ -32,8 +36,10 @@ DALi requires a compiler supporting C++17 features.
 To build for desktop first ensure ALL sources are selected:
  - Go to Ubuntu Settings and then to "Software & Updates"
  - In the "Ubuntu Software" tab, ensure ALL software sources are ticked
+   (This is required because we install some community-maintained free & open-source software)
+ - Install Perl Recursive support:
 
-(This is required because we install some community-maintained free & open-source software)
+         $ sudo apt install libfile-copy-recursive-perl
 
 Then you can create a dali-env folder in your home folder with:
 
@@ -133,3 +139,31 @@ vcpkg-script folder in the windows-dependencies repository.
     - 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.
+
+## 4. Building for macOS
+
+### 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
+```