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

docs: refresh README

Browse Source 
Signed-off-by: Alex T <alext.mkrs@gmail.com>
This commit is contained in:
Alex T
2025-10-11 21:17:09 +02:00
committed by Tom Ingleby
parent d8a04f39c1
commit 9d4319d0f1
1 changed files with 13 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -1,23 +1,21 @@
<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>
Eclipse Mraa - Low Level I/O Communications Library for GNU/Linux platforms Eclipse MRAA - Low Level I/O Communications Library for GNU/Linux Platforms
=========================================================================== ===========================================================================
Eclipse Mraa (Libmraa) is a C/C++ library with bindings to Java, Python and JavaScript Eclipse MRAA (Libmraa) is a C/C++ library with bindings to Java, Python and JavaScript
to interface with the I/O pins and buses on various IoT and Edge platforms, with a to interface with the I/O pins and buses on various IoT and Edge platforms, with a
structured and sane API where port names/numbering match the board that you are on. structured and sane API where port names/numbering match the board that you are on.
Use of libmraa does not tie you to specific hardware. Since board detection done at Use of libmraa does not tie you to specific hardware. Since board detection is done at
runtime you can create portable code that will work across the supported platforms. runtime you can create portable code that will work across the supported platforms.
The intent is to make it easier for developers and sensor manufacturers to map The intent is to make it easier for developers and sensor manufacturers to map
their sensors & actuators on top of supported hardware and to allow control of their sensors & actuators on top of supported hardware and to allow control of
low level communication protocol by high level languages & constructs. low level communication protocol by high level languages & constructs.
The MRAA project is an Eclipse IoT project. A detailed project description can be found [here](https://projects.eclipse.org/proposals/eclipse-mraa). The MRAA project is an Eclipse IoT project. A detailed project description can be found [here](https://projects.eclipse.org/projects/iot.mraa).
[![Build Status](https://travis-ci.org/intel-iot-devkit/mraa.svg?branch=master)](https://travis-ci.org/intel-iot-devkit/mraa) [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=mraa-master&metric=alert_status)](https://sonarcloud.io/dashboard?id=mraa-master)
Supported Boards Supported Boards
================ ================
@@ -87,7 +85,7 @@ RISC-V
---- ----
* [VisionFive](../master/docs/visionfive.md) * [VisionFive](../master/docs/visionfive.md)
Installing on your board Installing on Your Board
======================== ========================
Installing on Ubuntu Installing on Ubuntu
@@ -134,22 +132,11 @@ sudo zypper in mraa
A full list of packages and instructions for installing MRAA for various openSUSE releases A full list of packages and instructions for installing MRAA for various openSUSE releases
can be found [here](https://software.opensuse.org/package/mraa). can be found [here](https://software.opensuse.org/package/mraa).
Install on Fedora Linux Installing on Other Linux Distributions
-----------------------
There is an mraa package in the main Fedora repository so it can be dnf installed
in all recent Fedora releases. The Node.js and Python 3 bindings are packaged as
separate packages.
```bash
sudo dnf install mraa nodejs-mraa python3-mraa
```
Installing for Red Hat Enterprise Linux, CentOS and Other Linux Distributions
--------------------------- ---------------------------
The MRAA project does not currently distribute official binaries for RHEL The MRAA project does not currently distribute official binaries for other distributions
or CentOS so developers will have to compile the project from sources as so developers will have to compile the project from sources as
described in the next section. described in the next section.
For testing and development purposes it may be possible to share and install For testing and development purposes it may be possible to share and install
@@ -176,6 +163,10 @@ glance at our [debugging](../master/docs/debugging.md) page too.
API Documentation API Documentation
================= =================
**UNDER CONSTRUCTION:** we are working on re-hosting our documentation, so below
links don't work. Please use the sources and Markdown files under [docs](docs/)
in the meanwhile.
<a href="http://c.mraa.io"><img src="http://iotdk.intel.com/misc/logos/c++.png"/></a> <a href="http://c.mraa.io"><img src="http://iotdk.intel.com/misc/logos/c++.png"/></a>
<a href="http://java.mraa.io"><img src="http://iotdk.intel.com/misc/logos/java.png"/></a> <a href="http://java.mraa.io"><img src="http://iotdk.intel.com/misc/logos/java.png"/></a>
<a href="http://py.mraa.io"><img src="http://iotdk.intel.com/misc/logos/python.png"/></a> <a href="http://py.mraa.io"><img src="http://iotdk.intel.com/misc/logos/python.png"/></a>