X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=README.md;h=74affe9f8a4471e2ef744863af2fa2ed29650ec8;hb=e760c69ee1bf0f3a988ad01941493907f29b0db1;hp=3de790b2763726456bcb9189ed683cd15d5ca963;hpb=30c8f79173666ffe7b94364e233e25e686f198fb;p=platform%2Fcore%2Fuifw%2Fdali-demo.git diff --git a/README.md b/README.md index 3de790b..74affe9 100644 --- a/README.md +++ b/README.md @@ -11,17 +11,25 @@ * [NON-SMACK Targets](#non-smack-targets) * [SMACK enabled Targets](#smack-enabled-targets) * [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. + * [5. Building for MacOS](#5-building-for-macos) * [Creating an example](#creating-an-example) - * [Installing Emscripten Examples](#installing-emscripten-examples) # Build Instructions ## 1. Building for Ubuntu desktop -### Minimum Requirements +### Requirements - - Ubuntu 14.04 or later + - Ubuntu 16.04 or later - Environment created using dali_env script in dali-core repository + - GCC version 9 + - Cmake version 3.8.2 or later + +DALi requires a compiler supporting C++17 features. ### Building the Repository @@ -58,6 +66,10 @@ 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" + # Creating an example - Make a directory in the "examples" directory. Only one example will be created per directory. @@ -66,14 +78,136 @@ Before running make install as normal: - 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. -# Installing Emscripten Examples +## 3. Building for Android + +### Requirements + + - Ubuntu 16.04 or later + - Android DALi dependencies + - If you are behind a proxy, please set up the "http_proxy" and "https_proxy" environment variables appropriately + - Clone dali-core, dali-adaptor, dali-toolkit & android-dependencies to the same folder as dali-demo + - Android dependencies can be cloned from: https://github.com/dalihub/android-dependencies + +### Building the Repository +To build the repository enter the 'build/android' folder: + + $ cd dali-demo/build/android + +Then run the following command: + + $ ./build.sh + +For debug build: + + $ DEBUG=1 ./build.sh + +To debug from Android Studio set Android DALi enviroment using setenv script in 'build/android' and launch Android Studio from the enviroment: + + $ . setenv + $ /bin/studio.sh + +To clean the build: + + $ ./build.sh clean + +To install apks: + + $ adb install -r ./app/build/outputs/apk/debug/dali-demo-debug.apk + $ adb install -r ./app/build/outputs/apk/release/dali-demo-release.apk + +Manually granting permission for accessing Storage before running the demo + 1. Long press the DALi demo app icon => App Info + 2. Permissions => Storage => Enable + +## 4. 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 -DINTERNATIONALIZATION=OFF -DCMAKE_INSTALL_PREFIX=$DALI_ENV_FOLDER + $ 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). + - 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. + + * 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. + + i.e + $ setx DALI_ENV_FOLDER C:/Users/username/dali-env + $ setx DALI_IMAGE_DIR $DALI_ENV_FOLDER/share/dali/toolkit/images/ + $ setx DALI_SOUND_DIR $DALI_ENV_FOLDER/share/dali/toolkit/sounds/ + $ setx DALI_STYLE_DIR $DALI_ENV_FOLDER/share/dali/toolkit/styles/ + $ setx DALI_STYLE_IMAGE_DIR $DALI_ENV_FOLDER/share/dali/toolkit/styles/images/ + $ setx DALI_DATA_READ_ONLY_DIR $DALI_ENV_FOLDER/share/dali/ + +## 5. Building for MacOS + +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: +```zsh +% cd dali-demo/build/tizen +``` +Then run the following command to set up the build: +```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: +```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. -Some Emscripten Javascript examples are included in dali-demo. -They do not require building, to install them run the provided install script. -Note: Your dali-env must be setup as it will install to your dali-env/opt/share/emscripten directory. - $ cd ./emscripten-examples - $ ./install.sh -Run the examples by either opening them in a browser, or, running the browser from the command line with an example as a parameter.