Updated README files to refer to usage of scons
authorRavi Nanjundappa <nravi.n@samsung.com>
Fri, 12 Jun 2015 09:43:12 +0000 (15:13 +0530)
committerErich Keane <erich.keane@intel.com>
Mon, 15 Jun 2015 14:58:11 +0000 (14:58 +0000)
Changed README files in resource/csdk/connectivity/samples/linux/
and resource/csdk/stack/ directories to refer to usage of scons
instead of make commands.
Removed trailing whitspaces as well, as recommended from Erich
and also removed the references to sample.sh as per
https://gerrit.iotivity.org/gerrit/#/c/1253/

Change-Id: I9f61ea80c12b48f0a86ea4ff24e0758d288ddc8e
Signed-off-by: Ravi Nanjundappa <nravi.n@samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/1254
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Erich Keane <erich.keane@intel.com>
resource/csdk/connectivity/samples/linux/README
resource/csdk/stack/README

index 99f365d..bc122b4 100644 (file)
@@ -1,31 +1,17 @@
-//----------------------------------------------------------------------
-// NOTICE - Transition to SCONS
-//----------------------------------------------------------------------
-
-The IoTivity build system is transitioning to SCONS. Although the 
-makefiles are still available (until v1.0) and some developers are 
-still using them, they are currently no longer supported. To learn more 
-about building using SCONS see Readme.scons.txt in the repository root 
-directory. The build steps used in continuous integration can be found
+The build steps used in continuous integration can be found
 in auto_build.sh which is also in the the repository root directory.
 
-//----------------------------------------------------------------------
+Go to the top directory of 'iotivity' project(Note: should always run 'scons'
+command in this directory)
 
-#1. build "connectivity" project
-       - execute make command in "connectivity/build/" folder.
+#1. build "connectivity" project (for release mode)
+       - execute 'scons resource/csdk/connectivity/' command
 
 #2. build "example" for linux
-       - execute make command in "connectivity/samples/linux/" folder.
+       - execute 'scons resource/csdk/connectivity/samples/linux/' command
 
 #3. execute sample program
        - you should link the "connectivity_abstraction" library.
-       ex. LD_LIBRARY_PATH=../../../build/out ./sample_main
-       
-#4     execute sample.sh in "connectivity/samples/linux/" folder
- ex.    $./sample.sh (This will make a clean build and execute application)
-
-#4     execute sample.sh in if you want to build with DTLS
- ex.    $./sample.sh  WITH_DTLS (This will make a clean build and execute application)
-
-
+       ex. cd out/linux/x86/release/resource/csdk/connectivity/samples/linux
+           ./casample
 
index 965b476..88af931 100644 (file)
@@ -1,24 +1,22 @@
 Build notes
 
-//-------------------------------------------------
-//  NOTICE - Transition to SCONS
-//-------------------------------------------------
-
-The IoTivity build system is transitioning to SCONS. Although the 
-makefiles are still available (until v1.0) and some developers are 
-still using them, they are currently no longer supported. To learn more 
-about building using SCONS see Readme.scons.txt in the repository root 
-directory. The build steps used in continuous integration can be found
+The build steps used in continuous integration can be found
 in auto_build.sh which is also in the the repository root directory.
 
+Go to the top directory of 'iotivity' project(Note: should always run 'scons'
+command in this directory)
+
 //-------------------------------------------------
 // Linux
 //-------------------------------------------------
-To build, run
-make
+To build release binaries:
+      $ scons resource/csdk/stack
+
+    Build debug binaries:
+      $ scons resource/csdk/stack RELEASE=false
 
-To enable logging, ensure that 
--D TB_LOG 
+To enable logging, ensure that
+-D TB_LOG
 is set in the compiler flags
 
 //-------------------------------------------------
@@ -31,7 +29,7 @@ LOCAL_CFLAGS := -DTB_LOG
 //-------------------------------------------------
 // Arduino
 //-------------------------------------------------
-To enable the logger for Arduino, TB_LOG should be defined in 
+To enable the logger for Arduino, TB_LOG should be defined in
 Properties|C/C++ Build|Settings|Tool Settings|AVR Compiler|Symbols
 and
 Properties|C/C++ Build|Settings|Tool Settings|AVR C++ Compiler|Symbols