Skip to content

Commit 9d4319d

Browse files
alext-mkrstingleby
authored andcommitted
docs: refresh README
Signed-off-by: Alex T <alext.mkrs@gmail.com>
1 parent d8a04f3 commit 9d4319d

File tree

1 file changed

+13
-22
lines changed

1 file changed

+13
-22
lines changed

README.md

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,21 @@
11
<p align="center">
2-
<img src="http://iotdk.intel.com/misc/logos/mraa.png" height="150px" width="auto" algt="Mraa Logo"/>
2+
<img src="http://iotdk.intel.com/misc/logos/mraa.png" height="150px" width="auto" algt="MRAA Logo"/>
33
</p>
44

5-
Eclipse Mraa - Low Level I/O Communications Library for GNU/Linux platforms
5+
Eclipse MRAA - Low Level I/O Communications Library for GNU/Linux Platforms
66
===========================================================================
77

8-
Eclipse Mraa (Libmraa) is a C/C++ library with bindings to Java, Python and JavaScript
8+
Eclipse MRAA (Libmraa) is a C/C++ library with bindings to Java, Python and JavaScript
99
to interface with the I/O pins and buses on various IoT and Edge platforms, with a
1010
structured and sane API where port names/numbering match the board that you are on.
11-
Use of libmraa does not tie you to specific hardware. Since board detection done at
11+
Use of libmraa does not tie you to specific hardware. Since board detection is done at
1212
runtime you can create portable code that will work across the supported platforms.
1313

1414
The intent is to make it easier for developers and sensor manufacturers to map
1515
their sensors & actuators on top of supported hardware and to allow control of
1616
low level communication protocol by high level languages & constructs.
1717

18-
The MRAA project is an Eclipse IoT project. A detailed project description can be found [here](https://projects.eclipse.org/proposals/eclipse-mraa).
19-
20-
[![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)
18+
The MRAA project is an Eclipse IoT project. A detailed project description can be found [here](https://projects.eclipse.org/projects/iot.mraa).
2119

2220
Supported Boards
2321
================
@@ -87,7 +85,7 @@ RISC-V
8785
----
8886
* [VisionFive](../master/docs/visionfive.md)
8987

90-
Installing on your board
88+
Installing on Your Board
9189
========================
9290

9391
Installing on Ubuntu
@@ -134,22 +132,11 @@ sudo zypper in mraa
134132
A full list of packages and instructions for installing MRAA for various openSUSE releases
135133
can be found [here](https://software.opensuse.org/package/mraa).
136134

137-
Install on Fedora Linux
138-
-----------------------
139-
140-
There is an mraa package in the main Fedora repository so it can be dnf installed
141-
in all recent Fedora releases. The Node.js and Python 3 bindings are packaged as
142-
separate packages.
143-
144-
```bash
145-
sudo dnf install mraa nodejs-mraa python3-mraa
146-
```
147-
148-
Installing for Red Hat Enterprise Linux, CentOS and Other Linux Distributions
135+
Installing on Other Linux Distributions
149136
---------------------------
150137

151-
The MRAA project does not currently distribute official binaries for RHEL
152-
or CentOS so developers will have to compile the project from sources as
138+
The MRAA project does not currently distribute official binaries for other distributions
139+
so developers will have to compile the project from sources as
153140
described in the next section.
154141

155142
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.
176163
API Documentation
177164
=================
178165

166+
**UNDER CONSTRUCTION:** we are working on re-hosting our documentation, so below
167+
links don't work. Please use the sources and Markdown files under [docs](docs/)
168+
in the meanwhile.
169+
179170
<a href="http://c.mraa.io"><img src="http://iotdk.intel.com/misc/logos/c++.png"/></a>
180171
<a href="http://java.mraa.io"><img src="http://iotdk.intel.com/misc/logos/java.png"/></a>
181172
<a href="http://py.mraa.io"><img src="http://iotdk.intel.com/misc/logos/python.png"/></a>

0 commit comments

Comments
 (0)