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

2 files changed, 15 insertions, 7 deletions

diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..547b9d4
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,4 @@
+utils/* linguist-documentation
+utils/* linguist-vendored
+CMakeLists.txt linguist-vendored
+build.py linguist-vendored
diff --git a/README.md b/README.md
index 49a7fba..8d677ee 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,13 @@
 # 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](https://github.com/JakobST1n/hoverbit-ble/tree/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, you can access it [here](http://jakobst1n.github.io/hoverbit-ble/). It works the best if you install it on your device, usually you should get a prompt to install it when accessing the site. 
+
+Only tested on __Google Chrome__! Will __NOT__ work on Safari (as apple doesn't allow web bluetooth). I have not tested on IOS, but it should work with chrome there as well.
 
 ## Usage
 ### 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. 
+Get the last [hex file](https://github.com/JakobST1n/hoverbit-ble/releases/latest) from 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.
 
@@ -17,7 +19,7 @@ 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.
+I have used a docker image to compile the source. The [Dockerfile](https://github.com/JakobST1n/hoverbit-ble/blob/master/Dockerfile) is in the root of this repo. Using a docker container 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 .
@@ -27,10 +29,12 @@ 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.
 
+## Versions
+There is no connection between the version of the app and the version of the MICRO:BIT code, other than that major versions is supposed to be compatible. Meaning that if you come over some problems, and don't find a [issue](https://github.com/JakobST1n/hoverbit-ble/issues) describing your problem. You should first check that the major version of both the app and microbit hex is the same (e.g. app `1.0.8-alpha.0`and MICRO:BIT `1.0.1`, where the first number is the major).
+
 ## 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.
+Take a look at [active issues](https://github.com/JakobST1n/hoverbit-ble/issues). Submit a issue there if find any problems.
 
 ## Credits
-- Current icon [made by strip](https://www.flaticon.com/authors/srip) from [Flaticon](https://www.flaticon.com/)
+- The [micro:bit Web Bluetooth](https://github.com/thegecko/microbit-web-bluetooth) library is used by the webapp for bluetooth communication with the MICRO:BIT.
+- Joysticks on webapp is from the [nipplejs](https://yoannmoi.net/nipplejs/) library.