From c44b15f938e001551ffd302268597ecdebdfba66 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?King=20K=C3=A9vin?= <kingkevin@cuvoodoo.info>
Date: Mon, 30 Sep 2019 13:38:19 +0200
Subject: [PATCH] improve mardwon readme

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..011b914
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+these Linux programs read out the measurements from the WEB/WITRN/GZUt/QWay U2/U2p USB power meter.
+
+go to [wiki](https://wiki.cuvoodoo.info/doku.php?id=web-u2) for more information about the device and protocols.
+
+USB
+===
+
+`u2_usb` reads the measurements using the USB HID interface.
+
+to compile the source code you require: gcc, make, hidapi library (libhidapi-dev).
+then just run `make` and it will output the `u2_usb` binary.
+
+run `u2_usb` to get the output in CSV format.
+run `u2_usb -d` to get the raw and decoded output (useful for reversing and debugging).
+
+Bluetooth
+=========
+
+to compile the source code you require: gcc, make, dbus library (libdbus-1-dev).
+then just run `make` and it will output the `u2_bt` binary.
+
+ensure the BlueZ Bluetooth stack is running:
+```
+sudo systemctl start bluetooth
+```
+don't forget to grant the permissions to access bluetooth devices:
+```
+sudo adduser $USER bluetooth
+```
+
+run `u2_bt` to get the output in CSV format.
+run `u2_bt -d` to get the raw and decoded output (useful for reversing and debugging).
+
+I did not implement the possibility to specify the Bluetooth adapter and device.
+the program uses the first Bluetooth adapter it finds, and first device with the name starting with Qway_U2.