README.md: improve github front page doc
[contrib/mraa.git] / 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 Rev D](../master/docs/galileorevd.md)
16 * [Galileo Rev H](../master/docs/galileorevh.md)
17
18 Compiling
19 =========
20
21 See documentation on [building](../master/docs/building.md)
22
23 Examples
24 ========
25
26 See the [examples](../../tree/master/examples) available for various languages
27
28 C/C++ API Documentation
29 ===========
30
31 The C/C++ documentation is available [here](http://iotdk.intel.com/docs/master/mraa/)
32
33 Python API Documentation
34 ===========
35
36 The Python documentation is available [here](http://iotdk.intel.com/docs/master/mraa/python)
37
38 NodeJS API documentation
39 ===========
40
41 There is no explicit nodejs API documentation, see the examples. The API itself
42 is very similar to the python one but with a js syntax. If you know of an
43 autodoc tool for generating nodejs APIs from a native C++ nodejs extension
44 please get in touch!