X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=README.md;h=3395a032a68c8a73c42fd423d180260de68b06c8;hb=5b215c3f668dd40beab016ea426699a89c171d71;hp=b78598d7af052b7ec0a8e6fb6cad696c2a4ec78c;hpb=a770afdd3196e242b4938dfb2cbec3b5666593b2;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/README.md b/README.md index b78598d..3395a03 100644 --- a/README.md +++ b/README.md @@ -7,29 +7,29 @@ * [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 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 ## 1. Building for Ubuntu desktop -### Requirements +### Minimum Requirements - - Ubuntu 14.04 or later - - GCC version 6 - -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. + - 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 @@ -101,4 +101,67 @@ vcpkg-script folder in the windows-dependencies repository. $ git clone https://github.com/dalihub/windows-dependencies.git -- Read the README.md and vcpkg-script/Readme.md files for more instructions on how to install and build the third-party dependencies. \ No newline at end of file +- 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 -DENABLE_LINK_TEST=OFF -DCMAKE_INSTALL_PREFIX=$DALI_ENV_FOLDER -DINSTALL_CMAKE_MODULES=ON + $ 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). + - 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 +```