Added DS-5 Streamline tracing support

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

diff --git a/README.md b/README.md
index 4bfe52a..f198769 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,9 +10,10 @@
          * [Building and executing test cases](#building-and-executing-test-cases)
       * [2. GBS Builds](#2-gbs-builds)
          * [DEBUG Builds](#debug-builds)
+         * [DS-5 Streamline Trace Builds](#ds-5-streamline-trace-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-the-visual-studio-project)
+         * [Build with CMake](#build-with-cmake)
       * [4. Building for MacOS](#4-building-for-macos)
 
 # Build Instructions
@@ -57,6 +58,13 @@ See the README.md in dali-adaptor/automated-tests.
          $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
 
 
+### DS-5 Streamline Trace Builds
+
+By default, when using a GBS build, trace is enabled but Ttrace is used.
+If you want to use DS-5 Streamline instead then do the following:
+
+         $ gbs build -A [TARGET_ARCH] --define "%enable_streamline 1"
+
 ## 3. Building for MS Windows
 
 Third party dependencies are built using vcpkg. Instructions on how to install vcpkg can be found in the
@@ -105,20 +113,19 @@ vcpkg-script folder in the windows-dependencies repository.
 
 ## 4. Building for MacOS
 
-Here it is expected that the environment variables are set accordingly to
-`dali-core/README.md`.
+It is assumed that the DALi environment has been set up & that DALi Core has been built accordingly.
 
 To build the repository enter the 'build/tizen' folder:
-```bash
-         $ cd dali-adaptor/build/tizen
+```zsh
+% cd dali-adaptor/build/tizen
 ```
 Then run the following command to set up the build:
-```bash
-         $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_TOOLCHAIN_FILE=$VCPKG_FOLDER/scripts/buildsystems/vcpkg.cmake -DINSTALL_CMAKE_MODULES=ON -DENABLE_PROFILE=MACOS -DPROFILE_LCASE=macos
+```zsh
+% cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_TOOLCHAIN_FILE=$VCPKG_FOLDER/scripts/buildsystems/vcpkg.cmake -DINSTALL_CMAKE_MODULES=ON -DENABLE_PROFILE=MACOS -DPROFILE_LCASE=macos
 ```
 If a Debug build is required, then add `-DCMAKE_BUILD_TYPE=Debug -DENABLE_DEBUG=ON`
 
-To build run:
-```bash
-         $ make install -j8
+To build, run:
+```zsh
+% make install -j8
 ```