Skip to content

Commit 8ea0eb5

Browse files
author
Tauno Magnusson
committed
Reverted to original README.md file
1 parent 0368cab commit 8ea0eb5

File tree

1 file changed

+39
-21
lines changed

1 file changed

+39
-21
lines changed

README.md

Lines changed: 39 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,48 @@
1-
README.md
1+
[![Mbed OS][mbed-os-logo]][mbed-os-link]
22

3-
Fork of mbed-os to add support for new target STM32 "NUCLEO-G431KB" Board.
4-
Rebased to mbed-os-6.5.0
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]
56

6-
Howto (using mbed-cli):
7+
[mbed-os-logo]: logo.png
8+
[mbed-os-link]: https://www.mbed.com/en/platform/mbed-os/
9+
[mbed-travis-master]: https://travis-ci.org/ARMmbed/mbed-os
10+
[mbed-travis-master-svg]: https://travis-ci.org/ARMmbed/mbed-os.svg?branch=master
11+
[mbed-travis-release]: https://travis-ci.org/ARMmbed/mbed-os/branches
12+
[mbed-travis-release-svg]: https://travis-ci.org/ARMmbed/mbed-os.svg?branch=latest
13+
[mbed-coveralls-tools]: https://coveralls.io/github/ARMmbed/mbed-os?branch=master
14+
[mbed-coveralls-tools-svg]: https://coveralls.io/repos/github/ARMmbed/mbed-os/badge.svg?branch=master
715

8-
Alt A:
16+
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.
917

10-
mbed import https://github.com/taunomagnusson/mbed-os-nucleo-g431kb.git
11-
cd mbed-os-nucleo-g431kb
12-
Add a "main.cpp" file, for example the main.cpp from here: https://github.com/ARMmbed/mbed-os-example-blinky/blob/master/main.cpp
13-
mbed compile
18+
Mbed OS provides a platform that includes:
1419

15-
Alt B (2-level directory structure (works with VisualGDB)):
20+
- Security foundations.
21+
- Cloud management services.
22+
- Drivers for sensors, I/O devices and connectivity.
1623

17-
mkdir g431kb
18-
cd g431kb
19-
git clone https://github.com/taunomagnusson/mbed-os-nucleo-g431kb.git
20-
mv mbed-os-nucleo-g431kb mbed-os
21-
mbed new .
22-
Add a "main.cpp" file, for example the main.cpp from here: https://github.com/ARMmbed/mbed-os-example-blinky/blob/master/main.cpp
23-
mbed compile
24+
## Release notes
25+
The [release notes](https://os.mbed.com/releases) detail the current release. You can also find information about previous versions.
2426

25-
To run MBED tests:
27+
## License and contributions
2628

27-
rm main.cpp
28-
mbedls -m 0851:NUCLEO_G431KB
29-
mbed test -c
29+
The software is provided under the [Apache-2.0 license](LICENSE-apache-2.0.txt). Contributions to this project are accepted under the same license. Please see [contributing.md](CONTRIBUTING.md) for more information.
30+
31+
This project contains code from other projects. The original license text is included in those source files. They must comply with our [license guide](https://os.mbed.com/docs/mbed-os/latest/contributing/license.html).
32+
33+
Folders containing files under different permissive license than Apache 2.0 are listed in the [LICENSE](LICENSE.md) file.
34+
35+
## Getting started for developers
36+
37+
We have a [developer website](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.
38+
39+
## Getting started for contributors
40+
41+
We also have a [contributing and publishing guide](https://os.mbed.com/contributing/) that covers licensing, contributor agreements and style guidelines.
42+
43+
## Documentation
44+
45+
For more information about Mbed OS, please see [our published documentation](https://os.mbed.com/docs/latest). It includes Doxygen for our APIs, step-by-step tutorials, porting information and background reference materials about our architecture and tools.
46+
47+
To contribute to this documentation, please see the [mbed-os-5-docs repository](https://github.com/ARMmbed/mbed-os-5-docs).
3048

0 commit comments

Comments
 (0)