pxt-calliope/docs/packages.md

49 lines
1.3 KiB
Markdown
Raw Normal View History

2016-05-05 15:20:18 +02:00
# Extensions
You can publish libraries (also known as packages or extensions)
that users can then add to their scripts. These typically
provide a driver for a particular hardware device you can connect
to a microbit.
* [Sample C++ extension](https://github.com/Microsoft/pxt-microbit-cppsample)
* [Sample TypeScript extension](https://github.com/Microsoft/pxt-microbit/tree/master/libs/i2c-fram)
## Finding libraries
2016-05-27 16:06:24 +02:00
From the editor, the user clicks on **More** then **Add Package** and searches for the package.
To see the list of packages, click on **More** then **Show Files** to see the project file list.
To remove a package, click on the garbage button in the file list next to the package.
2016-05-05 15:20:18 +02:00
## Publishing libraries
2016-06-01 16:42:03 +02:00
Packages can be published from the pxt command line. We are still sorting out the details.
## Localizing libraries
It is possible to package localization strings for the **jsDoc** description associated to the API in the package.
When compiling a package, the PXT compiler generates a `strings.json` file under the `_locales/` folder.
This file contains a map from the symbol name to the en
```
{
...
"basic": "Provides access to basic micro:bit functionality.",
...
}
```
```
{
"basic.clearScreen": "Eteint toutes les diodes."
}
```
```
_locales/
_locales/fr/strings.json
_locales/pt-BR/strings.json
```