X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=720d60f82d6dbfa0e13b02520c659dfcdc563291;hb=refs%2Ftags%2Fdali_2.2.27;hp=c27d776a9de992ddfc250801354e6d8313d6077b;hpb=1e9295a9beaeb0b1b35b09adbe8d4d8a6a2e3f84;p=platform%2Fcore%2Fuifw%2Fdali-demo.git diff --git a/README.md b/README.md index c27d776..720d60f 100644 --- a/README.md +++ b/README.md @@ -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,6 +73,14 @@ Before running make install as normal: $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1" +### Raspberry Pi builds + + $ gbs build -A [TARGET_ARCH] --define "%rpi_style 1" + +### Build specific sample only + + $ gbs build -A [TARGET_ARCH] --define "build_example_name hello-world" + # Creating an example - Make a directory in the "examples" directory. Only one example will be created per directory. @@ -158,6 +173,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. @@ -171,20 +187,39 @@ vcpkg-script folder in the windows-dependencies repository. ## 5. 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, Adaptor & Toolkit have been built accordingly. To build the repository enter the 'build/tizen' folder: -```bash - $ cd dali-demo/build/tizen +```zsh +% cd dali-demo/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 -DINTERNATIONALIZATION=OFF -DENABLE_PKG_CONFIGURE=OFF +```zsh +% cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_TOOLCHAIN_FILE=$VCPKG_FOLDER/scripts/buildsystems/vcpkg.cmake -DINTERNATIONALIZATION=OFF ``` If a Debug build is required, then add `-DCMAKE_BUILD_TYPE=Debug` To build, run: -```bash - $ make install -j8 +```zsh +% make install -j8 ``` + +# Creating an example +In the dali-demo/examples folder, add another folder. This will become the name of your example executable, so for example the "hello-world" folder generates a "hello-world.example" binary. +In this folder, you can add as many source code files as you need. + +Usually, create a single class file containing a main function that instantiates an Application. Usually, the class is named after your example, followed by "Controller", e.g. hello-world.cpp contains a class called HelloWorldController. + +There is a DemoHelper::CreateView method, which enables you to easiliy set up a title bar and buttons. + +Add at least a key handler such that Escape or Back keys can be used to quit the application. Some apps that only present a single thing also add a touch handler that quits the application. + +Add a launcher line to one of demo/dali-demo.cpp, examples-reel/dali-examples-reel.cpp or tests-reel/dali-tests-reel.cpp, depending on the nature of what you are demonstrating. Generally, dali-demo is for graphical showcase demos, dali-examples-reel is for reasonable examples that look ok, and dali-tests is for examples that are only for testing. This needs a language string defining for the title. + +Add 2 lines to shared/dali-demo-strings.h for the title of your application, please keep in alphabetic ordering. Add english strings and translations to each of the language files in resources/po. + +To ensure your application can run on a Tizen device through the launcher, add an entry to com.samsung.dali-demo.xml, ensuring that only tabs are used for XML indent. + + + +