microbit-samples: updated readme.md

This commit is contained in:
James Devine 2016-04-06 15:49:57 +01:00
parent d4a13a453e
commit 714cdc2d64

View file

@ -1,3 +1,24 @@
# microbit-samples
[insert documentation URL here, when we are live]
A collection of example programs using the micro:bit runtime.
## Overview
The micro:bit runtime provides an easy to use environment for programming the BBC micro:bit in the C/C++ language, written by Lancaster University. It contains device drivers for all the hardware capabilities of the micro:bit, and also a suite of runtime mechanisms to make programming the micro:bit easier and more flexible. These range from control of the LED matrix display to peer-to-peer radio communication and secure Bluetooth Low Energy services. The micro:bit runtime is proudly built on the ARM mbed and Nordic nrf51 platforms.
In addition to supporting development in C/C++, the runtime is also designed specifically to support higher level languages provided by our partners that target the micro:bit. It is currently used as a support library for all the languages on the BBC www.microbit.co.uk website, including Microsoft Block, Microsoft TouchDevelop, Code Kingdoms JavaScript and Micropython languages.
## Links
[micro:bit runtime docs](http://lancaster-university.github.io/microbit-docs/) | [microbit-dal](https://github.com/lancaster-university/microbit-dal) | [uBit](https://github.com/lancaster-university/microbit)
## Build Environments
| Build Environment | Documentation |
| ------------- |-------------|
| ARM mbed online | http://lancaster-university.github.io/microbit-docs/online-toolchains/#mbed |
| yotta | http://lancaster-university.github.io/microbit-docs/offline-toolchains/#yotta |
## BBC Community Guidelines
[BBC Community Guidelines](https://www.microbit.co.uk/help#sect_cg)