pxt-calliope/README.md

60 lines
1.9 KiB
Markdown
Raw Normal View History

2016-04-07 22:34:52 +02:00
# micro:bit target for PXT
2016-03-10 23:21:48 +01:00
2016-04-07 22:33:55 +02:00
This target allow to program a [BBC micro:bit](https://www.microbit.co.uk/) using
2016-05-27 06:38:11 +02:00
PXT ([Microsoft Programming Experience Toolkit](https://github.com/Microsoft/pxt)).
2016-03-10 23:21:48 +01:00
2016-05-11 06:43:12 +02:00
* [Try it live](https://m.pxt.io)
2016-04-07 22:33:55 +02:00
[![Build Status](https://travis-ci.org/Microsoft/pxt-microbit.svg?branch=master)](https://travis-ci.org/Microsoft/pxt-microbit)
2016-03-11 06:11:16 +01:00
2016-05-19 19:34:24 +02:00
## Local server
### Setup
2016-03-10 23:26:59 +01:00
2016-05-18 18:18:14 +02:00
The following commands are a 1-time setup after synching the repo on your machine.
2016-06-16 17:01:28 +02:00
* clone this repo to your computer
2016-05-18 18:18:14 +02:00
* install the PXT command line
```
npm install -g pxt
```
* install the dependencies
```
npm install
```
2016-05-19 19:34:24 +02:00
### Running
2016-06-06 19:14:56 +02:00
Run this command to open a local web server (add ``sudo`` for Mac/Linux shells)
2016-05-18 18:18:14 +02:00
```
pxt serve
```
2016-05-27 06:38:11 +02:00
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.
2016-06-06 19:14:56 +02:00
If you need modify the `.cpp` files, turn on yotta compilation with the ``-yt`` flag (add ``sudo`` for Mac/Linux shells):
2016-05-27 06:38:11 +02:00
```
pxt serve -yt
```
2016-06-06 19:14:56 +02:00
To make sure you're running the latest tools, run (add ``sudo`` for Mac/Linux shells)
2016-05-19 19:34:24 +02:00
```
2016-06-06 19:14:56 +02:00
pxt update
2016-05-19 19:34:24 +02:00
```
2016-05-18 18:18:14 +02:00
More instructions at https://github.com/Microsoft/pxt#running-a-target-from-localhost
2016-04-08 05:48:00 +02:00
## Universal Windows App
2016-04-08 22:49:53 +02:00
The Windows 10 app is a [Universal Windows Hosted Web App](https://microsoftedge.github.io/WebAppsDocs/en-US/win10/CreateHWA.htm)
2016-05-27 06:38:11 +02:00
that wraps ``m.pxt.io`` and provides additional features.
2016-04-08 22:49:53 +02:00
### Building
* Install Visual Studio 2015 Update 2 or higher. Make sure the Windows 10 templates are installed.
2016-05-11 06:43:41 +02:00
* open the ``win10/app.sln`` solution and launch the ``m.pxt.io`` project.
2016-06-21 22:17:42 +02:00
## Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.