add descriptions

This commit is contained in:
Peli de Halleux 2016-08-17 09:44:15 -07:00
parent 46995cbd54
commit 269254796d
13 changed files with 32 additions and 7 deletions

View File

@ -23,6 +23,8 @@ input.onButtonPressed(Button.B, () => {
``` ```
# About # About
### @description A Blocks / Javascript code editor for the micro:bit, a pocket-size computer with 5x5 display, sensors and Bluetooth.
The [BBC micro:bit](https://www.microbit.co.uk) is a [pocket-size computer](/device) with a 5x5 display of 25 LEDs, Bluetooth and sensors that can be programmed by anyone. The [BBC micro:bit](https://www.microbit.co.uk) is a [pocket-size computer](/device) with a 5x5 display of 25 LEDs, Bluetooth and sensors that can be programmed by anyone.
The BBC micro:bit was made possible by many [partners](https://www.microbit.co.uk/partners). The BBC micro:bit was made possible by many [partners](https://www.microbit.co.uk/partners).

View File

@ -1,5 +1,7 @@
# Blocks language # Blocks language
### @description Langugage constructs for the Block editor.
```namespaces ```namespaces
for (let i = 0;i<5;++i) {} for (let i = 0;i<5;++i) {}
if (true){} if (true){}

View File

@ -1,5 +1,7 @@
# Documentation # Documentation
### @description Links to the documentation, reference and projects.
### Things to do ### Things to do
* **[Getting Started](/getting-started)** * **[Getting Started](/getting-started)**

View File

@ -1,5 +1,7 @@
# Frequently Asked Questions # Frequently Asked Questions
### @description Frequently asked questions and answers from our users.
### Where can I get a BBC micro:bit? ### Where can I get a BBC micro:bit?
More information at [http://uk.farnell.com/bbc-microbit](http://uk.farnell.com/bbc-microbit). More information at [http://uk.farnell.com/bbc-microbit](http://uk.farnell.com/bbc-microbit).

View File

@ -1,5 +1,7 @@
# Getting started # Getting started
### @description An activity for beginners to get started with the micro:bit
## ~avatar ## ~avatar
Here are some challenges for you. Arrange the blocks in the editor Here are some challenges for you. Arrange the blocks in the editor

View File

@ -1,4 +1,4 @@
# JavaScript and TypeScript # JavaScript
Visit the cards below to starting programming JavaScript and TypeScript with the micro:bit: Visit the cards below to starting programming JavaScript and TypeScript with the micro:bit:

View File

@ -1,5 +1,7 @@
# Lessons # Lessons
### @description Lessons to teach computer science and coding.
### @short Lessons ### @short Lessons
### ~column ### ~column

View File

@ -2,7 +2,7 @@
The editor is open source on GitHub under the MIT license. Contributions are welcome, please check our GitHub repos. The editor is open source on GitHub under the MIT license. Contributions are welcome, please check our GitHub repos.
### Source Code ## Source Code
* [microsoft/pxt-microbit](https://github.com/Microsoft/pxt-microbit), PXT target for BBC micro:bit, also includes the documentation. * [microsoft/pxt-microbit](https://github.com/Microsoft/pxt-microbit), PXT target for BBC micro:bit, also includes the documentation.
* [microbit/pxt](https://github.com/Microsoft/pxt), programming experience toolkit (PXT) * [microbit/pxt](https://github.com/Microsoft/pxt), programming experience toolkit (PXT)
@ -12,3 +12,8 @@ The editor is open source on GitHub under the MIT license. Contributions are wel
The [C++ micro:bit runtime](http://lancaster-university.github.io/microbit-docs/), created at [Lancaster University](http://www.lancaster.ac.uk/), provides access to the hardware functions of the micro:bit, The [C++ micro:bit runtime](http://lancaster-university.github.io/microbit-docs/), created at [Lancaster University](http://www.lancaster.ac.uk/), provides access to the hardware functions of the micro:bit,
as well as a set of helper functions (such as displaying a number/image/string on the LED screen). as well as a set of helper functions (such as displaying a number/image/string on the LED screen).
## Packages
* [microsoft/pxt-neopixel](https://github.com/microsoft/pxt-neopixel), package for neopixel strips
* [microsoft/pxt-max6675](https://github.com/microsoft/pxt-max6675), package for Temperature Probe (MAX6675)

View File

@ -1,4 +1,4 @@
# Extensions # Packages
You can publish libraries (also known as packages or extensions) You can publish libraries (also known as packages or extensions)
that users can then add to their scripts. These typically that users can then add to their scripts. These typically
@ -10,7 +10,7 @@ to a microbit.
* [Sample C++ extension](https://github.com/Microsoft/pxt-microbit-cppsample) * [Sample C++ extension](https://github.com/Microsoft/pxt-microbit-cppsample)
* [Sample TypeScript extension](https://github.com/Microsoft/pxt-microbit/tree/master/libs/i2c-fram) * [Sample TypeScript extension](https://github.com/Microsoft/pxt-microbit/tree/master/libs/i2c-fram)
## Finding libraries ## Finding packages
From the editor, the user clicks on **More** then **Add Package** and searches for the package. From the editor, the user clicks on **More** then **Add Package** and searches for the package.
@ -18,11 +18,11 @@ To see the list of packages, click on **More** then **Show Files** to see the pr
To remove a package, click on the garbage button in the file list next to the package. To remove a package, click on the garbage button in the file list next to the package.
## Publishing libraries ## Publishing packages
Packages can be published from the pxt command line. We are still sorting out the details. Packages can be published from the pxt command line. We are still sorting out the details.
## Localizing libraries ## Localizing packages
It is possible to package localization strings for the **jsDoc** description associated to the API in the package. It is possible to package localization strings for the **jsDoc** description associated to the API in the package.

View File

@ -1,5 +1,7 @@
# Reference # Reference
### @description List of API categories available in the editors
```namespaces ```namespaces
basic.showNumber(0); basic.showNumber(0);
input.onButtonPressed(Button.A, () => { input.onButtonPressed(Button.A, () => {

View File

@ -1,5 +1,7 @@
# Release notes # Release notes
### @description Editor release notes
```sim ```sim
basic.forever(() => { basic.showString("RELEASE NOTES"); }); basic.forever(() => { basic.showString("RELEASE NOTES"); });
``` ```

View File

@ -1,3 +1,5 @@
# Support # Support
Please use the [GitHub issue tracker](https://github.com/microsoft/pxt-microbit) to report bugs. Send us your feedback and ideas on our [User Voice Forum](https://touchdevelop.uservoice.com/forums/402381-code-the-micro-bit/).
You can also use our [GitHub issue tracker](https://github.com/microsoft/pxt-microbit) to report bugs.

View File

@ -1,5 +1,7 @@
# Uploader # Uploader
### @description A Windows application that automatically deploys .hex files to connected micro:bit boards
### ~avatar avatar ### ~avatar avatar
The Uploader **automatically** deploys .hex files to all micro:bits connected to your computer. The Uploader **automatically** deploys .hex files to all micro:bits connected to your computer.