README.md

   1 # IoT.js: Platform for Internet of Things with JavaScript
   2 [![License](https://img.shields.io/badge/licence-Apache%202.0-brightgreen.svg?style=flat)](LICENSE)
   3 [![Build Status](https://travis-ci.org/pando-project/iotjs.svg?branch=master)](https://travis-ci.org/pando-project/iotjs)
   4 [![Coverity Scan Build Status](https://scan.coverity.com/projects/12140/badge.svg)](https://scan.coverity.com/projects/samsung-iotjs)
   5 [![SonarCloud Status](https://sonarcloud.io/api/project_badges/measure?project=pando-project_iotjs&metric=alert_status)](https://sonarcloud.io/dashboard?id=pando-project_iotjs)
   6 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FSamsung%2Fiotjs.svg?type=shield)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FSamsung%2Fiotjs?ref=badge_shield)
   7 [![IRC Channel](https://img.shields.io/badge/chat-on%20freenode-brightgreen.svg)](https://kiwiirc.com/client/irc.freenode.net/#iotjs)
   8
   9 You can find project details on our [project page](http://pando-project.github.io/iotjs/) and [wiki](https://github.com/pando-project/iotjs/wiki).
  10
  11 Memory usage and Binary footprint are measured at [here](https://pando-project.github.io/iotjs-test-results) with real target daily.
  12
  13 The following table shows the latest results on the devices:
  14
  15 |      Artik053         | [![Remote Testrunner](https://firebasestorage.googleapis.com/v0/b/jsremote-testrunner.appspot.com/o/status%2Fiotjs%2Fartik053.svg?alt=media&token=1)](https://pando-project.github.io/iotjs-test-results/?view=artik053)  |
  16 |        :---:          |                                             :---:                                                                                                |
  17 | **Artik530**    | [![Remote Testrunner](https://firebasestorage.googleapis.com/v0/b/jsremote-testrunner.appspot.com/o/status%2Fiotjs%2Fartik530.svg?alt=media&token=1)](https://pando-project.github.io/iotjs-test-results/?view=artik530)          |
  18 | **Raspberry Pi 2**    | [![Remote Testrunner](https://firebasestorage.googleapis.com/v0/b/jsremote-testrunner.appspot.com/o/status%2Fiotjs%2Frpi2.svg?alt=media&token=1)](https://pando-project.github.io/iotjs-test-results/?view=rpi2)          |
  19 | **STM32F4-Discovery** | [![Remote Testrunner](https://firebasestorage.googleapis.com/v0/b/jsremote-testrunner.appspot.com/o/status%2Fiotjs%2Fstm32f4dis.svg?alt=media&token=1)](https://pando-project.github.io/iotjs-test-results/?view=stm32f4dis)   |
  20
  21
  22 IRC channel: #iotjs on [freenode](https://freenode.net)
  23 Mailing list: iotjs-dev@groups.io, you can subscribe [here](https://groups.io/g/iotjs-dev) and access the mailing list archive [here](https://groups.io/g/iotjs-dev/topics).
  24
  25 ## Quick Start
  26 ### Getting the sources
  27
  28 ```bash
  29 git clone https://github.com/pando-project/iotjs.git
  30 cd iotjs
  31 ```
  32
  33 ### How to Build
  34
  35 ```bash
  36 tools/build.py
  37 ```
  38
  39 ### How to Test
  40
  41 ```bash
  42 tools/testrunner.py build/x86_64-linux/debug/bin/iotjs
  43 ```
  44
  45
  46 For Additional information see [Getting Started](docs/Getting-Started.md).
  47
  48 ## Documentation
  49 - [Getting Started](docs/Getting-Started.md)
  50 - [API Reference](docs/api/IoT.js-API-reference.md)
  51
  52 ## License
  53 IoT.js is Open Source software under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0). Complete license and copyright information can be found within the code.
  54
  55 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FSamsung%2Fiotjs.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FSamsung%2Fiotjs?ref=badge_large)
  56
  57 > Copyright 2015-present Samsung Electronics Co., Ltd. and other contributors
  58
  59 > Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  60
  61 > Copyright Node.js contributors. All rights reserved.
  62
  63 > Permission is hereby granted, free of charge, to any person obtaining a copy
  64  of this software and associated documentation files (the "Software"), to
  65  deal in the Software without restriction, including without limitation the
  66  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  67  sell copies of the Software, and to permit persons to whom the Software is
  68  furnished to do so, subject to the following conditions:
  69
  70 > The above copyright notice and this permission notice shall be included in
  71  all copies or substantial portions of the Software.
  72
  73 > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  74  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  75  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  76  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  77  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  78  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  79  IN THE SOFTWARE.
  80
  81 > This license applies to parts of '*.js' files in '/src/js', implementing node.js
  82  compatible API, originating from the https://github.com/nodejs/node repository: