|
|
||
|---|---|---|
| .vscode | ||
| clients | ||
| cmds | ||
| docfiles | ||
| docs | ||
| editor | ||
| electron | ||
| libs | ||
| sim | ||
| tests | ||
| theme | ||
| .gitattributes | ||
| .gitignore | ||
| .travis.yml | ||
| CONTRIBUTING.md | ||
| faviconDescription.json | ||
| LICENSE.txt | ||
| package.json | ||
| ptrcheck-ignore | ||
| pxtarget.json | ||
| README.md | ||
| targetconfig.json | ||
| THIRD-PARTY-NOTICES.txt | ||
| travis-tests.sh | ||
| tslint.json | ||
| webmanifest.json | ||
micro:bit target for PXT
This target allow to program a BBC micro:bit using PXT (Microsoft Programming Experience Toolkit).
Issue tracking
All issue tracking for this repo happens at https://github.com/Microsoft/pxt, see you there!
Local server
The local server allows to run the editor and the documentation from your computer.
Setup
The following commands are a 1-time setup after synching the repo on your machine.
- See requirements for pxt
- clone this repo to your computer and go in the project folder
git clone https://github.com/microsoft/pxt-microbit
cd pxt-microbit
- install the PXT command line (add
sudofor Mac/Linux shells).
npm install -g pxt
- install the dependencies
npm install
Running
Run this command to open a local web server (add sudo for Mac/Linux shells)
pxt serve
If the local server opens in the wrong browser, make sure to copy the URL containing the local token. Otherwise, the editor will not be able to load the projects.
If you need modify the .cpp files, turn on yotta compilation with the -yt flag (add sudo for Mac/Linux shells):
pxt serve -yt
Updates
To update your PXT version and make sure you're running the latest tools, run (add sudo for Mac/Linux shells)
pxt update
More instructions at https://github.com/Microsoft/pxt#running-a-target-from-localhost
Testing
The build automatically runs the following:
- make sure the built-in packages compile
pxt runinlibs/lang-test*- this will run the test in command line runner; there is a number of asserts in both of thesepxt testdirintests- this makes sure all the files compile and generates .hex files- run the TD->TS converter on a number of test scripts from
microbit.co.ukand make sure the results compile
To test something on the device:
- do a
pxt deployinlibs/lang-test*- they should show1or2on the screen (and not unhappy face) - run
pxt testdirintestsand deploy some of the hex files fromtests/built
The lang-test0 source comes from the pxt-core package. It's also tested with pxt run there.
Repos
There are a number of repos that pxt-microbit depends on. The main ones are:
- https://github.com/Microsoft/pxt, the PXT framework
- https://github.com/lancaster-university/microbit, basic wrapper around the DAL
- https://github.com/lancaster-university/microbit-dal
Versions
Current serviced versions of pxt-microbit:
| pxt-microbit | v0.12.* | release | uses pxt/v0 v.0.12.* | pxt-microbit | v0.13.* | accessibility | uses pxt/v0 v.0.13.* (with accessibility)
Code of Conduct
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.