Merge branch 'master' of https://github.com/JakobST1n/hoverbit-ble

1 files changed, 26 insertions, 8 deletions

diff --git a/README.md b/README.md
index 2e034e6..49a7fba 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,36 @@
 # HOVER:BIT Bluetooth Controller software
 This is software for controlling the HOVER:BIT kit with a progressive web app.
 
-The web app lives in the `controller` branch, it uses the [micro:bit Web Bluetooth](https://github.com/thegecko/microbit-web-bluetooth) library.
+The web app lives in the [controller](https://github.com/JakobST1n/hoverbit-ble/tree/controller) branch, it uses the [micro:bit Web Bluetooth](https://github.com/thegecko/microbit-web-bluetooth) library.
 
 ## 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.
+### Flashing the micro:bit
+Get the last [hex file](https://github.com/JakobST1n/hoverbit-ble/releases/) for the Releases, and flash your micro:bit with this file. 
+To do this, plug the micro:bit into your computer. The micro:bit will then appear as a removable flash drive, then simply copy (drag-drop)
+the hex-file into the flash-drive folder.
 
+### Controlling the hover:bit
+Navigate to [the progressive web app](https://jakobst1n.github.io/hoverbit-ble/) on a phone, and press connect.
+Press `arm` when you are connected, then you can use the throttle on the right, and rudder on the bottom to controll
+the hover:bit.
+
+## Compiling the hex-file yourself
+Clone or fork this repo locally, and navigate to that folder in your terminal of choice. At this point you have two choises:
+### Docker image
+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 and a lot less work to get up and running. Just build the container, and run it with a volume as a bind-mount to the code-directory.
+```sh
+# Build the image on your machine
+docker build -t microbit-tools .
+# Build the hex-file
+docker run -v $(pwd):/app --rm microbit-tools
 ```
-    # Build the image on your machine
-    docker build -t microbit-tools .
-    # Build the hex-file
-    docker run -v $(pwd):/app --rm microbit-tools
-```
+### Manually
+[Refer to this repo's readme](https://github.com/lancaster-university/microbit-v2-samples). This is in theory not hard, but if you like me have a lot of toolchains for compiling to other architectures already installed, it could be a bit of work to make function properly.
+
+## Known issues
+- [ ] No multitouch support on webapp yet, this makes it difficult to use it, to make it a bit easier you can enable `Sticky controls`.
+- [ ] Things often stop working if you have been connected, drop the connection and then reconnect. I don't know exacly why, to circumvent this you can restart the webapp, and boot the micro:bit.
+- [ ] There is no failsafe-mode currently, this should be implemented according to the spektsat protocol.
 
 ## Credits
 - Current icon [made by strip](https://www.flaticon.com/authors/srip) from [Flaticon](https://www.flaticon.com/)