aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..629b622
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# HOVER:BIT Bluetooth Controller software
+
+
+
+
+## Usage
+First you need to flash your micro:bit with the hex-file on the releases-page, or you can
+compile it yourself. I have been using the docker image provided by [Lancaster university](https://github.com/lancaster-university/microbit-v2-samples/blob/master/Dockerfile), because it is rather convenient.
+
+```
+ # Build the image on your machine
+ docker build -t microbit-tools .
+ # Build the hex-file
+ docker run -v $(pwd):/app --rm microbit-tools
+```