Add readme

2016-03-10 14:21:48 -08:00
parent 1a17bfac04
commit f1acffa399
2 changed files with 18 additions and 4 deletions
--- a/README.md
+++ b/README.md
@ -1,2 +1,16 @@
-# yelm-microbit
-A yelm target for microbit
+# microbit target for KindScript
+
+
+## Local run
+
+Make sure `kindscript-microbit` is in a directory next to `kindscript`.
+
+```
+cd ../kindscript
+jake
+cd ../kindscript-microbit
+npm link ../kindscript
+kind serve
+```
+
+To re-build the `built/target.json` file, re-run `kind serve`.