Merge "Update gitignore."

[platform/upstream/iotivity.git] / Readme.scons.txt

diff --git a/Readme.scons.txt b/Readme.scons.txt
index d0e2458..f2be67f 100644 (file)
--- a/Readme.scons.txt
+++ b/Readme.scons.txt
@@ -1,3 +1,33 @@
+== Quick guide: build and run IoTivity projects on Ubuntu ==
+
+1. Build
+       Go to the top directory of 'iotivity' project(Note: should always run 'scons'
+command in this directory)
+
+    Install external libraries:
+      $ sudo apt-get install libboost-dev libboost-program-options-dev libexpat1-dev libboost-thread-dev
+
+    Build release binaries:
+      $ scons
+(Note: C++ sdk requires cereal. Please follow the instruction in the build
+message to install cereal)
+
+    Build debug binaries:
+      $scons RELEASE=false
+
+    Help:
+      $ scons -h
+
+    Clear:
+      $ scons -c
+
+2. Run the samples
+      $ export LD_LIBRARY_PATH=<iotivity>/out/linux/x86_64/release
+      Run the c++ samples in <iotivity>/out/linux/x86_64/release/resource/examples
+      Run the c samples in <iotivity>/out/linux/x86_64/release/resource/csdk/stack/samples/linux/SimpleClientServer
+('<iotivity>' is the path to 'iotivity' project. If your device is x86, arm,
+or arm64, please change 'x86_64' to the proper arch)
+
 == How to build IoTivity projects ==
 
 IoTivity includes a series of projects. You can find all these projects here:
@@ -102,7 +132,7 @@ For help about how to set an option, please run:
 
 1. Build IoTivity project for Linux
       $ cd <top directory of the project>
-      $ sudo apt-get install libboost-dev libboost-program-options-dev libexpat1-dev
+      $ sudo apt-get install libboost-dev libboost-program-options-dev libexpat1-dev libboost-thread-dev
       $ scons
 
 2. Build IoTivity project for Android
@@ -125,6 +155,13 @@ processors, to specify the processor, add 'CPU=zzz' in the command line. If no
 'CPU' option exists, that means the board only support one kind of processor,
 it's unnecessary to specify it)
 
+4. Build Iotivity project for Tizen
+      $ cd <top directory of the project>
+      $ gbs build -A xxx --packaging-dir tools/tizen/
+(xxx can be i586 or armv7l, we provide the spec file required by gbs tool at
+toools/tizen directory. gbs is default build tool for Tizen platfrom, we can
+refer the following wiki to setup Tizen development environment:
+https://source.tizen.org/documentation/developer-guide/getting-started-guide)
 
 === Build IoTivity project on Windows ===