README.md

   1 MRAA - Low Level Skeleton Library for Communication on GNU/Linux platforms
   2 ==============
   3
   4 Library in C/C++ to interface with Galileo & other Intel platforms, in a
   5 structured and sane API with port names/numbering that match boards & with
   6 bindings to javascript & python.
   7
   8 The intent is to make it easier for developers and sensor manufacturers to map
   9 their sensors & actuators on top of supported hardware and to allow control of
  10 low level communication protocol by high level languages & constructs.
  11
  12 Supported Boards
  13 ================
  14
  15 * [Galileo Gen 1 - Rev D](../master/docs/galileorevd.md)
  16 * [Galileo Gen 2 - Rev H](../master/docs/galileorevh.md)
  17
  18 Installing on your board
  19 ========
  20
  21 See the section below on compiling or use our repository to install on an
  22 eglibc based yocto poky image that supports opkg. Adding this repository is as
  23 simple as:
  24
  25 ``` bash
  26 echo "src mraa-upm http://iotdk.intel.com/repos/1.1/intelgalactic" > /etc/opkg/mraa-upm.conf
  27 opkg update
  28 opkg install libmraa0
  29 ```
  30
  31 Compiling
  32 =========
  33
  34 See documentation on [building](../master/docs/building.md)
  35
  36 Examples
  37 ========
  38
  39 See the [examples](../../tree/master/examples) available for various languages
  40
  41 C/C++ API Documentation
  42 ===========
  43
  44 The C/C++ documentation is available [here](http://iotdk.intel.com/docs/master/mraa/)
  45
  46 Python API Documentation
  47 ===========
  48
  49 The Python documentation is available [here](http://iotdk.intel.com/docs/master/mraa/python)
  50
  51 NodeJS API documentation
  52 ===========
  53
  54 There is no explicit nodejs API documentation, see the examples. The API itself
  55 is very similar to the python one but with a js syntax. If you know of an
  56 autodoc tool for generating nodejs APIs from a native C++ nodejs extension
  57 please get in touch!