clang-format: added .clang-format with rules adhere to dali coding guidelines.
[platform/core/uifw/dali-core.git] / README.md
1 <img src="https://dalihub.github.io/images/DaliLogo320x200.png">
2
3 # Table of Contents
4
5    * [Build Instructions](#build-instructions)
6       * [1. Building for Ubuntu desktop](#1-building-for-ubuntu-desktop)
7          * [Minimum Requirements](#minimum-requirements)
8          * [Creating a DALi Environment](#creating-a-dali-environment)
9          * [Building the Repository](#building-the-repository)
10          * [Building and executing test cases](#building-and-executing-test-cases)
11       * [2. GBS Builds](#2-gbs-builds)
12          * [NON-SMACK Targets](#non-smack-targets)
13          * [SMACK enabled Targets](#smack-enabled-targets)
14          * [DEBUG Builds](#debug-builds)
15       * [3. Building for MS Windows](#3-building-for-ms-windows)
16          * Build with the Visual Studio project.
17          * Build with CMake.
18
19 # Build Instructions
20
21 ## 1. Building for Ubuntu desktop
22
23 ### Minimum Requirements
24
25  - Ubuntu 16.04 or later
26  - GCC version 9
27  - Cmake version 3.8.2 or later
28
29 DALi requires a compiler supporting C++17 features.
30
31 ### Creating a DALi Environment
32
33 To build for desktop first ensure ALL sources are selected:
34  - Go to Ubuntu Settings and then to "Software & Updates"
35  - In the "Ubuntu Software" tab, ensure ALL software sources are ticked
36
37 (This is required because we install some community-maintained free & open-source software)
38
39 Then you can create a dali-env folder in your home folder with:
40
41          $ dali-core/build/scripts/dali_env -c
42
43 This will also download any dependencies that the dali repositories require.
44
45 You can save the environment variables to a file:
46
47          $ dali-env/opt/bin/dali_env -s > setenv
48
49 This process only needs to be done once.
50
51 Next source these variables:
52
53          $ . setenv
54
55 You will have to source these variables every time you open up a new terminal (or you can add to .bashrc if you prefer).
56
57
58 ### Building the Repository
59
60 To build the repository enter the 'build/tizen' folder:
61
62          $ cd dali-core/build/tizen
63
64 Then run the following command to set up the build:
65
66          $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX .
67
68 If a Debug build is required, then add -DCMAKE_BUILD_TYPE=Debug
69
70 To build run:
71
72          $ make install -j8
73
74 ### Building and executing test cases
75
76 See the README.md in dali-core/automated-tests.
77
78 ## 2. GBS Builds
79
80 ### NON-SMACK Targets
81
82          $ gbs build -A [TARGET_ARCH]
83
84 ### SMACK enabled Targets
85
86          $ gbs build -A [TARGET_ARCH] --define "%enable_dali_smack_rules 1"
87
88 ### DEBUG Builds
89
90          $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
91
92 ## 3. Building for MS Windows
93
94 Third party dependencies are built using vcpkg. Instructions on how to install vcpkg can be found in the
95 vcpkg-script folder in the windows-dependencies repository.
96
97 - Download the windows-dependencies repository from DaliHub
98
99          $ git clone https://github.com/dalihub/windows-dependencies.git
100
101 - Read the windows-dependencies/vcpkg-script/Readme.md file for more instructions on how to build and install the third-party dependencies.
102
103 ### Build with the Visual Studio project
104   Read the windows-dependencies/README.md file for more instructions on how to build and run DALi for MS Windows.
105
106 ### Build with CMake
107
108   * Requirements
109     It's required the version 3.12.2 of CMake and a Git Bash Shell.
110
111   * Notes and troubleshoting:
112     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.
113     However, the CMake version installed with MS Visual Studio 2017 is a bit out of date and some VCPKG modules require a higher version.
114     This instructions have been tested with CMake 3.12.2 on a Git Bash shell.
115
116   * Define an environment variable to set the path to the VCPKG folder
117
118     $ export VCPKG_FOLDER=C:/Users/username/Workspace/VCPKG_TOOL
119
120   * Define an environment variable to set the path where DALi is going to be installed.
121
122     $ export DALI_ENV_FOLDER=C:/Users/username/Workspace/dali-env
123
124   * Execute the following commands to create the makefiles, build and install DALi.
125
126     $ 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
127     $ cmake --build . --target install
128
129
130   * Options:
131     - CMAKE_TOOLCHAIN_FILE  ---> Needed to find packages installed by VCPKG.
132     - ENABLE_PKG_CONFIGURE  ---> Whether to install pkg configure files (not currently working on MS Windows. CMake modules used instead).
133     - ENABLE_LINK_TEST      ---> Whether to enable the link test (not currently working on MS Windows).
134     - CMAKE_INSTALL_PREFIX  ---> Were DALi is installed.
135     - INSTALL_CMAKE_MODULES ---> Whether to install the CMake modules (Used by the CMake command find_package() to find previously installed libraries).
136     - ENABLE_DEBUG          ---> Whether to build with debug enabled.