Skip to content

Commit 73bee05

Browse files
authored
Merge pull request #4100 from theotherjimmy/edit-readme
Edit the README and add Travis CI badges
2 parents 09de121 + aa1eefc commit 73bee05

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,30 @@
11
# ARM mbed OS
22

3-
mbed OS is an open-source embedded operating system designed specifically for the "things" in the Internet of Things (IoT). It includes all the features you need to develop a connected product based on an ARM Cortex-M microcontroller.
3+
mbed OS is an open-source embedded operating system designed for the "things" in the Internet of Things (IoT). mbed OS includes the features you need to develop a connected product using an ARM Cortex-M microcontroller.
44

5-
mbed OS accelerates the process of creating a connected product by providing a platform operating system that includes robust security foundations, standards based communication capabilities, built-in cloud management services, and drivers for sensors, I/O devices and connectivity. mbed OS is built as a modular, configurable software stack so that you can readily customize it to the device you're developing for, and reduce memory requirements by excluding unnecessary software components.
5+
mbed OS provides a platform that includes:
6+
- Security foundations.
7+
- Cloud management services.
8+
- Drivers for sensors, I/O devices and connectivity.
9+
10+
mbed OS is modular, configurable software that you can customize it to your device and to reduce memory requirements by excluding unused software.
11+
612

7-
## Current release
13+
## Release Notes
14+
15+
The [Release Notes](https://docs.mbed.com/docs/mbed-os-release-notes/en/latest/) detail the current release and previous versions.
16+
17+
## Continuous Integration Status
818

9-
The current release, along with a selection of previous versions are detailed here:
10-
[Release Notes](https://docs.mbed.com/docs/mbed-os-release-notes/en/latest/)
19+
We run continuous integration on all of our branches and pull requests to verify the stability of mbed OS. The following are the Travis CI indicators for mbed OS.
20+
21+
- Master branch [![Master Branch CI Badge](https://travis-ci.org/ARMmbed/mbed-os.svg?branch=master)](https://travis-ci.org/ARMmbed/mbed-os)
22+
- Latest release [![Latest Tag CI Badge](https://travis-ci.org/ARMmbed/mbed-os.svg?branch=latest)](https://travis-ci.org/ARMmbed/mbed-os/branches)
1123

1224
## Getting Started for Developers
1325

14-
Please note that you will require [mbed CLI](https://github.com/ARMmbed/mbed-cli) to build mbed OS. For more details, please read the getting started guide for developers using mbed OS in applications:
15-
16-
- [Getting Started](https://docs.mbed.com/docs/mbed-os-handbook/en/latest/)
26+
You need [mbed CLI](https://github.com/ARMmbed/mbed-cli) to build mbed OS. For more details, read the [mbed OS Handbook](https://docs.mbed.com/docs/mbed-os-handbook/en/latest/).
1727

1828
## Getting Started for Contributors
1929

20-
We have a getting started guide for contributors working on mbed OS:
21-
22-
- Have a look in the docs directory
30+
We have a [Contributing and Publishing Guide](https://docs.mbed.com/docs/mbed-os-handbook/en/latest/cont/contributing/) in the mbed OS Handbook.

0 commit comments

Comments
 (0)