diff --git a/README b/README.md similarity index 83% rename from README rename to README.md index b6098bb..432c543 100644 --- a/README +++ b/README.md @@ -1,4 +1,4 @@ -KNoT Thing library +# KNoT Thing library Copyright (c) 2016, CESAR. All rights reserved. @@ -6,8 +6,7 @@ All rights reserved. This software may be modified and distributed under the terms of the BSD license. See the COPYING file for details. -Introduction -============ +## Introduction KNoT Thing library is a lightweight C/C++ library built to use minimal CPU and memory resources. It is intended to run on KNoT Nodes (Things) (see KNoT @@ -16,29 +15,26 @@ Architecture for better understanding). It provides the Radio and Protocol abstractions for the application. The application builder just need implement the read/write functions for its sensors/actuators, register a Data Item (sensor or actuator) on the library and call the run() method - on its main loop routine. +on its main loop routine. - - -Compilation and installation -============================ +## Compilation and installation Currently the KNoT Thing library supports only the Arduino platform. The build process will generate an Arduino library zip file (KNoTThing.zip) containing all source code. This zip file can be imported on Arduino IDE. In order to compiler the source code you need following software packages: - - GCC compiler - - GNU C library +- GCC compiler +- GNU C library How to build: - make + > make How to install: - Refer to Arduino library guide in order to install KNoT Thing library on Arduino IDE: https://www.arduino.cc/en/Guide/Libraries + +Refer to Arduino library guide in order to install KNoT Thing library on Arduino IDE: https://www.arduino.cc/en/Guide/Libraries -Thing Status LED -================ +## Thing Status LED The Thing Status LED is used to report connection status (disconnected / connecting / connected) and also error status (invalid initialization / authentication error).