Raspberries/mraa
Private
Public Access
2
0
Fork 0
Code Activity

README.md: improve github front page doc

Browse Source 
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Brendan Le Foll
2014-08-14 11:27:22 +01:00
parent 450ebdeca8
commit 87f87c4524
1 changed files with 19 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -12,20 +12,33 @@ low level communication protocol by high level languages & constructs.
Supported Boards Supported Boards
================ ================
Galileo Rev D * [Galileo Rev D](../master/docs/galileorevd.md)
Galileo Rev H * [Galileo Rev H](../master/docs/galileorevh.md)
Compiling Compiling
========= =========
See docs/building.md. See documentation on [building](../master/docs/building.md)
Examples Examples
======== ========
See examples/ See the [examples](../../tree/master/examples) available for various languages
INFORMATION C/C++ API Documentation
=========== ===========
See docs/index.md for more information. The C/C++ documentation is available [here](http://iotdk.intel.com/docs/master/mraa/)
Python API Documentation
===========
The Python documentation is available [here](http://iotdk.intel.com/docs/master/mraa/python)
NodeJS API documentation
===========
There is no explicit nodejs API documentation, see the examples. The API itself
is very similar to the python one but with a js syntax. If you know of an
autodoc tool for generating nodejs APIs from a native C++ nodejs extension
please get in touch!