From 9d4319d0f1bcf046a24e9b1f2fad66ff3867d030 Mon Sep 17 00:00:00 2001 From: Alex T Date: Sat, 11 Oct 2025 21:17:09 +0200 Subject: [PATCH] docs: refresh README Signed-off-by: Alex T --- README.md | 35 +++++++++++++---------------------- 1 file changed, 13 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 3c7dc2f..044cb9d 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,21 @@

- +

-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 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. 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 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). - -[![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) +The MRAA project is an Eclipse IoT project. A detailed project description can be found [here](https://projects.eclipse.org/projects/iot.mraa). Supported Boards ================ @@ -87,7 +85,7 @@ RISC-V ---- * [VisionFive](../master/docs/visionfive.md) -Installing on your board +Installing on Your Board ======================== 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 can be found [here](https://software.opensuse.org/package/mraa). -Install on Fedora Linux ------------------------ - -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 +Installing on Other Linux Distributions --------------------------- -The MRAA project does not currently distribute official binaries for RHEL -or CentOS so developers will have to compile the project from sources as +The MRAA project does not currently distribute official binaries for other distributions +so developers will have to compile the project from sources as described in the next section. 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 ================= +**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. +