Skip to content

Commit 7bc8fa6

Browse files
committed
Readme updates for style and branding
Add a logo and reformat the readme layout. Update use of Mbed to align with Arm branding guidelines.
1 parent 2e1c2a1 commit 7bc8fa6

File tree

2 files changed

+27
-24
lines changed

2 files changed

+27
-24
lines changed

README.md

+27-24
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,35 @@
1-
# ARM mbed OS
2-
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.
4-
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.
1+
[![Mbed OS][mbed-os-logo]][mbed-os-link]
2+
3+
[![Build status release][mbed-travis-release-svg]][mbed-travis-release]
4+
[![Build status master][mbed-travis-master-svg]][mbed-travis-master]
5+
[![Tools coverage status][mbed-coveralls-tools-svg]][mbed-coveralls-tools]
6+
[![PR progress][mbed-waffle-svg]][mbed-waffle]
7+
8+
[mbed-os-logo]: logo.png
9+
[mbed-os-link]: https://www.mbed.com/en/platform/mbed-os/
10+
[mbed-travis-master]: https://travis-ci.org/ARMmbed/mbed-os
11+
[mbed-travis-master-svg]: https://travis-ci.org/ARMmbed/mbed-os.svg?branch=master
12+
[mbed-travis-release]: https://travis-ci.org/ARMmbed/mbed-os/branches
13+
[mbed-travis-release-svg]: https://travis-ci.org/ARMmbed/mbed-os.svg?branch=latest
14+
[mbed-coveralls-tools]: https://coveralls.io/github/ARMmbed/mbed-os?branch=master
15+
[mbed-coveralls-tools-svg]: https://coveralls.io/repos/github/ARMmbed/mbed-os/badge.svg?branch=master
16+
[mbed-waffle]: https://waffle.io/ARMmbed/mbed-os
17+
[mbed-waffle-svg]: https://badge.waffle.io/ARMmbed/mbed-os.svg?columns=all
18+
19+
Arm Mbed OS is an open source embedded operating system designed specifically for the "things" in the Internet of Things. It includes all the features you need to develop a connected product based on an Arm Cortex-M microcontroller, including security, connectivity, an RTOS, and drivers for sensors and I/O devices.
20+
21+
Mbed OS provides a platform that includes:
22+
* Security foundations.
23+
* Cloud management services.
24+
* Drivers for sensors, I/O devices and connectivity.
1125

12-
1326
## 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
18-
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)
23-
24-
Tools coverage [![Coverage Status](https://coveralls.io/repos/github/ARMmbed/mbed-os/badge.svg?branch=master)](https://coveralls.io/github/ARMmbed/mbed-os?branch=master)
27+
The [release notes](https://os.mbed.com/releases) detail the current release and you can also find information about previous versions.
2528

2629
## Getting Started for Developers
2730

28-
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/).
31+
We have a [developer webiste](https://os.mbed.com) for asking questions, engaging with others, finding information on boards and components, using an online IDE and compiler, reading the documentation and learning about what's new and what's coming next in Mbed OS.
2932

3033
## Getting Started for Contributors
3134

32-
We have a [Contributing and Publishing Guide](https://docs.mbed.com/docs/mbed-os-handbook/en/latest/cont/contributing/) in the mbed OS Handbook.
35+
We also have a [contributing and publishing guide](https://os.mbed.com/contributing/) that covers licensing, contributor agreements and style guidelines.

logo.png

36 KB
Loading

0 commit comments

Comments
 (0)