Skip to content

Commit

Permalink
Add markdown extension and syntax to README
Browse files Browse the repository at this point in the history
It fixes #5 improving the developer experience
Used markdown featured styling
  • Loading branch information
OtacilioN authored and vitbaq committed Jul 22, 2019
1 parent 5650fea commit ea8e220
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions README → README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
KNoT Thing library
# KNoT Thing library

Copyright (c) 2016, CESAR.
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
Expand All @@ -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).

Expand Down

0 comments on commit ea8e220

Please sign in to comment.