Peter M. Groen / dali-demo

Commit 30c8f79173666ffe7b94364e233e25e686f198fb

Authored by Paul Wisbey 2016-10-25 11:47:40 +0100

Changed README to README.md

Change-Id: I5f2679bf6c2b318aeb027b965a448385a7bb2ef0

Inline Side-by-side

Showing 2 changed files with 79 additions and 90 deletions

README deleted

View file @2a7bdb4

1		-T.O.C.
2		-======
3		-
4		- 1. GBS Builds
5		- 1.1. NON-SMACK Targets
6		- 1.2. SMACK enabled Targets
7		- 1.3. DEBUG Builds
8		- 2. Building for Ubuntu desktop
9		- 2.1. Minimum Requirements
10		- 2.2. Building the Repository
11		- 2.3. DEBUG Builds
12		- 3. Creating an example
13		- 4. Installing Emscripten examples
14		-
15		-
16		-1. GBS Builds
17		-=============
18		-
19		-1.1. NON-SMACK Targets
20		-----------------------
21		-
22		- gbs build -A [TARGET_ARCH]
23		-
24		-1.2. SMACK enabled Targets
25		---------------------------
26		-
27		- gbs build -A [TARGET_ARCH] --define "%enable_dali_smack_rules 1"
28		-
29		-1.3. DEBUG Builds
30		------------------
31		-
32		- gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
33		-
34		-
35		-
36		-2. Building for Ubuntu desktop
37		-==============================
38		-
39		-2.1. Minimum Requirements
40		-------------------------
41		-
42		- - Ubuntu 14.04
43		- - Environment created using dali_env script in dali-core repository
44		-
45		-2.2. Building the Repository
46		-----------------------------
47		-
48		-To build the repository enter the 'build/tizen' folder:
49		-
50		- cd dali-demo/build/tizen
51		-
52		-Then run the following commands:
53		-
54		- cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX .
55		- make install -j8
56		-
57		-2.3. DEBUG Builds
58		------------------
59		-
60		-Specify a debug build when building for desktop by passing the following parameter to cmake:
61		-
62		- cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_BUILD_TYPE=Debug .
63		-
64		-Before running make install as normal:
65		-
66		- make install -j8
67		-
68		-
69		-3. Creating an example
70		-======================
71		-
72		- - Make a directory in the "examples" directory. Only one example will be created per directory.
73		- - The executable installed will have a ".example" appended to it, e.g. a "blocks" directory produces "blocks.example".
74		- - Add all source files for the required example in this directory.
75		- - Modify "com.samsung.dali-demo.xml" to include your example so that it can be launched on target.
76		- - No changes are required to the make system as long as the above is followed, your example will be automatically built & installed.
77		-
78		-
79		-4. Installing Emscripten Examples
80		-=================================
81		-
82		-Some Emscripten Javascript examples are included in dali-demo.
83		-
84		-They do not require building, to install them run the provided install script.
85		-Note: Your dali-env must be setup as it will install to your dali-env/opt/share/emscripten directory.
86		-
87		-# cd ./emscripten-examples
88		-# ./install.sh
89		-
90		-Run the examples by either opening them in a browser, or, running the browser from the command line with an example as a parameter.

README.md 0 → 100644

View file @30c8f79

	1	+<img src="https://dalihub.github.io/images/DaliLogo320x200.png">
	2	+
	3	+# Table of Contents
	4	+
	5	+ * [Build Instructions](#build-instructions)
	6	+ * [1. Building for Ubuntu desktop](#1-building-for-ubuntu-desktop)
	7	+ * [Minimum Requirements](#minimum-requirements)
	8	+ * [Building the Repository](#building-the-repository)
	9	+ * [DEBUG Builds](#debug-builds)
	10	+ * [2. GBS Builds](#2-gbs-builds)
	11	+ * [NON-SMACK Targets](#non-smack-targets)
	12	+ * [SMACK enabled Targets](#smack-enabled-targets)
	13	+ * [DEBUG Builds](#debug-builds-1)
	14	+ * [Creating an example](#creating-an-example)
	15	+ * [Installing Emscripten Examples](#installing-emscripten-examples)
	16	+
	17	+# Build Instructions
	18	+
	19	+## 1. Building for Ubuntu desktop
	20	+
	21	+### Minimum Requirements
	22	+
	23	+ - Ubuntu 14.04 or later
	24	+ - Environment created using dali_env script in dali-core repository
	25	+
	26	+### Building the Repository
	27	+
	28	+To build the repository enter the 'build/tizen' folder:
	29	+
	30	+ $ cd dali-demo/build/tizen
	31	+
	32	+Then run the following commands:
	33	+
	34	+ $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX .
	35	+ $ make install -j8
	36	+
	37	+### DEBUG Builds
	38	+
	39	+Specify a debug build when building for desktop by passing the following parameter to cmake:
	40	+
	41	+ $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_BUILD_TYPE=Debug .
	42	+
	43	+Before running make install as normal:
	44	+
	45	+ $ make install -j8
	46	+
	47	+## 2. GBS Builds
	48	+
	49	+### NON-SMACK Targets
	50	+
	51	+ $ gbs build -A [TARGET_ARCH]
	52	+
	53	+### SMACK enabled Targets
	54	+
	55	+ $ gbs build -A [TARGET_ARCH] --define "%enable_dali_smack_rules 1"
	56	+
	57	+### DEBUG Builds
	58	+
	59	+ $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"
	60	+
	61	+# Creating an example
	62	+
	63	+ - Make a directory in the "examples" directory. Only one example will be created per directory.
	64	+ - The executable installed will have a ".example" appended to it, e.g. a "blocks" directory produces "blocks.example".
	65	+ - Add all source files for the required example in this directory.
	66	+ - Modify "com.samsung.dali-demo.xml" to include your example so that it can be launched on target.
	67	+ - No changes are required to the make system as long as the above is followed, your example will be automatically built & installed.
	68	+
	69	+# Installing Emscripten Examples
	70	+
	71	+Some Emscripten Javascript examples are included in dali-demo.
	72	+
	73	+They do not require building, to install them run the provided install script.
	74	+Note: Your dali-env must be setup as it will install to your dali-env/opt/share/emscripten directory.
	75	+
	76	+ $ cd ./emscripten-examples
	77	+ $ ./install.sh
	78	+
	79	+Run the examples by either opening them in a browser, or, running the browser from the command line with an example as a parameter.
...	...