X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=README.md;h=2e496c1deab8c8a82f0f3ec4b6cfbddc967c765c;hb=daeaa4502419b6d33071dd3b9e0c3b7e4893595b;hp=220f0ba8aab11538c3ff168f1e79a01857e2cd31;hpb=853600b419feddf78277218a1145fe3e26c8b3af;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/README.md b/README.md index 220f0ba..2e496c1 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,14 @@ * [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. # Build Instructions @@ -21,6 +23,14 @@ ### 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. + ### Creating a DALi Environment @@ -55,26 +65,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 @@ -94,3 +93,48 @@ See the README.md in dali-core/automated-tests. $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1" +## 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 + + $ 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 -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.