readme.md: minor formatting and content changes
Clarified the need for explicit call to addSubplatform when libmraa is installed from NPM, fixed heading, added link to Firmata subplatforms. Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
11
README.md
11
README.md
@@ -1,8 +1,9 @@
|
|||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="http://iotdk.intel.com/misc/logos/mraa.png" height="150px" width="auto" algt="Mraa Logo"/>
|
<img src="http://iotdk.intel.com/misc/logos/mraa.png" height="150px" width="auto" algt="Mraa Logo"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
libmraa - Low Level Skeleton Library for Communication on GNU/Linux platforms
|
libmraa - Low Level Skeleton Library for Communication on GNU/Linux platforms
|
||||||
==============
|
=============================================================================
|
||||||
|
|
||||||
Libmraa is a C/C++ library with bindings to Java, Python and JavaScript to
|
Libmraa is a C/C++ library with bindings to Java, Python and JavaScript to
|
||||||
interface with the IO on Galileo, Edison & other platforms, with a structured
|
interface with the IO on Galileo, Edison & other platforms, with a structured
|
||||||
@@ -26,7 +27,7 @@ X86
|
|||||||
* [Galileo Gen 2 - Rev H](../master/docs/galileorevh.md)
|
* [Galileo Gen 2 - Rev H](../master/docs/galileorevh.md)
|
||||||
* [Edison](../master/docs/edison.md)
|
* [Edison](../master/docs/edison.md)
|
||||||
* [Intel DE3815](../master/docs/intel_de3815.md)
|
* [Intel DE3815](../master/docs/intel_de3815.md)
|
||||||
* [Minnowboard Max](../master/docs/minnow_max.md)
|
* [Minnowboard](../master/docs/minnow_max.md)
|
||||||
* [NUC 5th generation](../master/docs/intel_nuc5.md)
|
* [NUC 5th generation](../master/docs/intel_nuc5.md)
|
||||||
* [UP](../master/docs/up.md)
|
* [UP](../master/docs/up.md)
|
||||||
* [Intel Joule](../master/docs/joule.md)
|
* [Intel Joule](../master/docs/joule.md)
|
||||||
@@ -45,6 +46,7 @@ FPGA
|
|||||||
USB
|
USB
|
||||||
---
|
---
|
||||||
* [FT4222](../master/docs/ftdi_ft4222.md)
|
* [FT4222](../master/docs/ftdi_ft4222.md)
|
||||||
|
* [Firmata](../master/docs/firmata.md)
|
||||||
|
|
||||||
Mock
|
Mock
|
||||||
----
|
----
|
||||||
@@ -69,7 +71,7 @@ sudo apt-get update
|
|||||||
sudo apt-get install libmraa1 libmraa-dev mraa-tools python-mraa python3-mraa
|
sudo apt-get install libmraa1 libmraa-dev mraa-tools python-mraa python3-mraa
|
||||||
```
|
```
|
||||||
|
|
||||||
Node.js package is available seperately.
|
Node.js package is available separately.
|
||||||
|
|
||||||
Install on Arch Linux
|
Install on Arch Linux
|
||||||
---------------------
|
---------------------
|
||||||
@@ -106,6 +108,9 @@ use mraa_init_json_platform(). Also building this way means the mraa.node
|
|||||||
includes a static version of libmraa rather than relying on a dynamic library
|
includes a static version of libmraa rather than relying on a dynamic library
|
||||||
in /usr/lib.
|
in /usr/lib.
|
||||||
|
|
||||||
|
Subplatforms (i.e. Firmata) have to be added manually with this kind of install
|
||||||
|
from your application, as shown in [this example](examples/javascript/firmata.js).
|
||||||
|
|
||||||
Installing on Intel 32bit Yocto based opkg image
|
Installing on Intel 32bit Yocto based opkg image
|
||||||
------------------------------------------------
|
------------------------------------------------
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user