pxt-calliope/README.md

48 lines
1.1 KiB
Markdown
Raw Normal View History

2016-03-11 06:10:03 +01:00
# micro:bit target for KindScript
2016-03-10 23:21:48 +01:00
2016-03-11 06:10:03 +01:00
This target allow to program a [BBC micro:bit](https://www.microbit.co.uk/) using [KindScript](https://github.com/Microsoft/kindscript).
2016-03-10 23:21:48 +01:00
2016-03-11 06:11:16 +01:00
[![Build Status](https://travis-ci.org/Microsoft/kindscript-microbit.svg?branch=master)](https://travis-ci.org/Microsoft/kindscript-microbit)
2016-03-11 06:10:03 +01:00
# Getting started
2016-03-10 23:26:59 +01:00
2016-03-11 06:10:03 +01:00
> If you're making changes to kindscript repository itself, proceed to **Local installation** below.
* Clone this repo and run
```
npm install
```
* Install the `KindScript` tool and launch the local server:
2016-03-10 23:26:59 +01:00
```
npm install -g kindscript-cli
kind serve
```
To re-build the `built/target.json` file, re-run `kind serve`.
## Local installation
2016-03-10 23:21:48 +01:00
2016-03-11 06:10:03 +01:00
* Clone and build [KindScript](https://github.com/Microsoft/kindscript) in a `kindscript` folder.
* Clone this repo in a `kindscript-microbit` folder next to `kindscript`
```
npm install
```
* To build and deploy new changes
2016-03-10 23:21:48 +01:00
```
2016-03-10 23:23:13 +01:00
npm install -g kindscript-cli
2016-03-10 23:21:48 +01:00
cd ../kindscript
jake
cd ../kindscript-microbit
npm link ../kindscript
2016-03-11 06:32:05 +01:00
```
* run this command to build and launch a local editor
```
2016-03-10 23:21:48 +01:00
kind serve
```
2016-03-11 06:10:03 +01:00
* open `localhost:3232` to try your editor!