more docs on building

This commit is contained in:
Peli de Halleux 2016-03-10 21:10:03 -08:00
parent ea0ae8a30c
commit 0dd1809609

View File

@ -1,11 +1,19 @@
# microbit target for KindScript # micro:bit target for KindScript
This target allow to program a [BBC micro:bit](https://www.microbit.co.uk/) using [KindScript](https://github.com/Microsoft/kindscript).
## Regular installation # Getting started
If you're making changes to kindscript repository itself, proceed to **Local installation** below. > 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:
Installation:
``` ```
npm install -g kindscript-cli npm install -g kindscript-cli
kind serve kind serve
@ -15,7 +23,13 @@ To re-build the `built/target.json` file, re-run `kind serve`.
## Local installation ## Local installation
Make sure `kindscript-microbit` is in a directory next to `kindscript`. * 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
``` ```
npm install -g kindscript-cli npm install -g kindscript-cli
@ -25,4 +39,4 @@ cd ../kindscript-microbit
npm link ../kindscript npm link ../kindscript
kind serve kind serve
``` ```
* open `localhost:3232` to try your editor!