mirror of https://github.com/OpenMTC/OpenMTC.git synced 2024-12-29 01:09:00 +00:00

Jason Fox 3fc8bdb14e Update to standard-readme format

* Moved badges to top - two rows
* Formatted Markdown file
* Added lede at the top of file so a description paragraph will display on mobile
* Standardized some Section names (e.g. Install)
* Added standard QA section - TSC **must** requirement
* Expanded License to include copyrights
* Updated catalogue links to new GitHub location

[standard-readme](https://github.com/RichardLitt/standard-readme) is a simple standard naming convention for README files which makes reading and navigation of the documentation easier - this is a TSC **should** requirement

Created Readthedocs index file.

2018-10-30 16:18:37 +01:00

4.5 KiB

Raw Blame History

The OpenMTC SDK aims to provide developers with a convenient yet flexible tool to write oneM2M compliant applications. This includes network applications (NAs), gateway application (GAs), device applications (DAs), as well as interworking proxy entities (IPEs).

This project is part of FIWARE. For more information check the FIWARE Catalogue entry for the IoT Agents.

Content

Install
Usage
API
Quality Assurance
License

Install

Information about how to install the JSON IoTAgent can be found at the corresponding section of the Installation & Administration Guide.

Usage

Information about how to use the IoT Agent can be found in the User & Programmers Manual.

API

Information about the REST API can be found in the API Section

Python

The OpenMTC SDK is written in and for the Python programming language. Users should therefore have at least a certain knowledge of Python and its paradigms. For this matter, the following material is recommended:

Feedback

Please create issues for any problems and direct any comments or feedback you are having to support@openmtc.org

Please let us know what you think. We are also very interested in any use case you are not able to implement with the SDK or if you find it difficult to do so.