From 30c8f79173666ffe7b94364e233e25e686f198fb Mon Sep 17 00:00:00 2001 From: Paul Wisbey Date: Tue, 25 Oct 2016 11:47:40 +0100 Subject: [PATCH] Changed README to README.md --- README | 90 ------------------------------------------------------------------------------------------ README.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 79 insertions(+), 90 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 05417af..0000000 --- a/README +++ /dev/null @@ -1,90 +0,0 @@ -T.O.C. -====== - - 1. GBS Builds - 1.1. NON-SMACK Targets - 1.2. SMACK enabled Targets - 1.3. DEBUG Builds - 2. Building for Ubuntu desktop - 2.1. Minimum Requirements - 2.2. Building the Repository - 2.3. DEBUG Builds - 3. Creating an example - 4. Installing Emscripten examples - - -1. GBS Builds -============= - -1.1. NON-SMACK Targets ----------------------- - - gbs build -A [TARGET_ARCH] - -1.2. SMACK enabled Targets --------------------------- - - gbs build -A [TARGET_ARCH] --define "%enable_dali_smack_rules 1" - -1.3. DEBUG Builds ------------------ - - gbs build -A [TARGET_ARCH] --define "%enable_debug 1" - - - -2. Building for Ubuntu desktop -============================== - -2.1. Minimum Requirements ------------------------- - - - Ubuntu 14.04 - - Environment created using dali_env script in dali-core repository - -2.2. Building the Repository ----------------------------- - -To build the repository enter the 'build/tizen' folder: - - cd dali-demo/build/tizen - -Then run the following commands: - - cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX . - make install -j8 - -2.3. DEBUG Builds ------------------ - -Specify a debug build when building for desktop by passing the following parameter to cmake: - - cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_BUILD_TYPE=Debug . - -Before running make install as normal: - - make install -j8 - - -3. 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. - - -4. Installing Emscripten Examples -================================= - -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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..3de790b --- /dev/null +++ b/README.md @@ -0,0 +1,79 @@ + + +# Table of Contents + + * [Build Instructions](#build-instructions) + * [1. Building for Ubuntu desktop](#1-building-for-ubuntu-desktop) + * [Minimum Requirements](#minimum-requirements) + * [Building the Repository](#building-the-repository) + * [DEBUG Builds](#debug-builds) + * [2. GBS Builds](#2-gbs-builds) + * [NON-SMACK Targets](#non-smack-targets) + * [SMACK enabled Targets](#smack-enabled-targets) + * [DEBUG Builds](#debug-builds-1) + * [Creating an example](#creating-an-example) + * [Installing Emscripten Examples](#installing-emscripten-examples) + +# Build Instructions + +## 1. Building for Ubuntu desktop + +### Minimum Requirements + + - Ubuntu 14.04 or later + - Environment created using dali_env script in dali-core repository + +### Building the Repository + +To build the repository enter the 'build/tizen' folder: + + $ cd dali-demo/build/tizen + +Then run the following commands: + + $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX . + $ make install -j8 + +### DEBUG Builds + +Specify a debug build when building for desktop by passing the following parameter to cmake: + + $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_BUILD_TYPE=Debug . + +Before running make install as normal: + + $ make install -j8 + +## 2. GBS Builds + +### NON-SMACK Targets + + $ gbs build -A [TARGET_ARCH] + +### SMACK enabled Targets + + $ gbs build -A [TARGET_ARCH] --define "%enable_dali_smack_rules 1" + +### DEBUG Builds + + $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1" + +# 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. + +# Installing Emscripten Examples + +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. -- libgit2 0.21.4