1 /******************************************************************
3 * Copyright 2014 Samsung Electronics All Rights Reserved.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
19 ******************************************************************/
22 ===============================================================================
23 == How to Build Things Manager ==
24 ===============================================================================
26 Once the source code is downloaded in your local specific folder, you may follow
27 the steps to build and execute Things Manager and its applications.
28 In this context, we assume that the code was downloaded into 'oic' folder.
30 =======================================
31 1. Download source code
32 =======================================
34 From the url, you can download Things Manager source code;
35 https://www.iotivity.org/downloads
37 Once you download the codes, and Make sure that the downloaded code structure is as follows;
38 Four directories for oic; extlib, resource, service, and tools.
45 The path for Things Manager is as following;
47 oic/service/things-manager
49 The things-manager directory includes following sub directories;
51 Directories Description
52 oic/service/things-manager/sdk : The SDK APIs for applications is located.
53 The main functionality of this SDK is to provide
54 developer-friendly APIs of Things manager component
55 to application developers.
56 oic/service/things-manager/sampleapp : It is the sample application on Ubuntu.
57 Basically, the input and output of application
58 on Ubuntu are displayed in the console.
59 oic/service/things-manager/build : Whole library files and binary files would be made
64 =======================================
66 =======================================
67 Simply, type "make" to build things manager as follows;
69 /oic/service/things-manager/build/linux$ make
71 =======================================
72 3. Build the API reference documentation
73 =======================================
74 To build the API reference documentation:
75 a. Navigate to oic-resource/docs folder using the terminal window.
76 b. Run the following command:
80 This command builds the API reference documentation in the output directory.
82 The output directory for this command is oic-resource/docs/html/index.html.