DALi Version 2.2.40

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

diff --git a/README.md b/README.md
index 29c195f..ec9bad2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,10 +13,10 @@
          * [DEBUG Builds](#debug-builds-1)
       * [3. Building for Android](#3-android-builds)
       * [4. Building for MS Windows](#4-windows-builds)
-         * 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)
       * [5. Building for MacOS](#5-building-for-macos)
-   * [Creating an example](#creating-an-example)
+   * [Creating an Example](#creating-an-example)
 
 # Build Instructions
 
@@ -52,6 +52,13 @@ Before running make install as normal:
 
          $ make install -j8
 
+### Build Only specific sample
+
+You can set the sample's name and can build that sample only. For example, If you want to build 'hello-world',
+
+         $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DBUILD_EXAMPLE_NAME=hello-world
+         $ make install -j9
+
 ## 2. GBS Builds
 
 ### NON-SMACK Targets
@@ -66,13 +73,13 @@ Before running make install as normal:
 
          $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
 
-# Creating an example
+### Raspberry Pi builds
 
- - Make a directory in the "examples" directory. Only one example will be created per directory.
- - The executable installed will have a ".example" appended to it, e.g. a "blocks" directory produces "blocks.example".
- - Add all source files for the required example in this directory.
- - Modify "com.samsung.dali-demo.xml" to include your example so that it can be launched on target.
- - No changes are required to the make system as long as the above is followed, your example will be automatically built & installed.
+         $ gbs build -A [TARGET_ARCH] --define "%rpi_style 1"
+
+### Build specific sample only
+
+         $ gbs build -A [TARGET_ARCH] --define "build_example_name hello-world"
 
 ## 3. Building for Android
 
@@ -158,6 +165,7 @@ vcpkg-script folder in the windows-dependencies repository.
     - INTERNATIONALIZATION  ---> Whether to generate and install internazionalization '.po' Portable Object files.
     - CMAKE_INSTALL_PREFIX  ---> Were DALi is installed.
     - ENABLE_DEBUG          ---> Whether to build with debug enabled.
+    - BUILD_EXAMPLE_NAME    ---> The name of sample what you want to build. To reduce the memory of rpm file, we didn't copy resources now.
 
   * If dali-toolkit has been compiled with the USE_DEFAULT_RESOURCE_DIR option disabled then is needed to set global environment variables in order to find the default toolkit resources.
 
@@ -187,3 +195,20 @@ To build, run:
 ```zsh
 % make install -j8
 ```
+
+# Creating an Example
+
+- Make a directory in the `examples` directory. Only one example will be created per directory.
+- The executable installed will have a `.example` appended to it, e.g. a `blocks` directory produces `blocks.example`.
+- Add all source files for the required example in this directory.
+- Modify `com.samsung.dali-demo.xml` to include your example so that it can be launched on target.
+- No changes are required to the make system as long as the above is followed, your example will be automatically built & installed.
+- Add a key handler so that the `ESC` or `Back` keys can be used to quit the application.
+- Depending on the nature of what you are demonstrating, add a launcher line to either:
+  - `demo/dali-demo.cpp`: for graphical showcase demos.
+  - `examples-reel/dali-examples-reel.cpp`: generic examples of how to use various features.
+  - `tests-reel/dali-tests-reel.cpp`: for testing purposes.
+- Add 2 lines to `shared/dali-demo-strings.h` for the title of your application, please keep in alphabetic order,
+- Add as many translations of the title as possible to the files in `resources/po`. Currently, this only works on Ubuntu.
+- In each example folder, create a README.md with images and a description of what the example is demonstrating.
+  Look at [this](examples/particle-system/README.md) for reference.
\ No newline at end of file