commit 92752768a63983108910aaa3e49df8fcf3c26721
from: Thomas Böhler <witcher@wiredspace.de>
date: Tue Dec  6 14:07:36 2022 UTC

Add README.md

commit - bee6e3d4a3b70dda9c3037c6bfd1659927fd9b08
commit + 92752768a63983108910aaa3e49df8fcf3c26721
blob - /dev/null
blob + 798ff1e668d04acdee6dc4bfb0346c50469f2052 (mode 644)
--- /dev/null
+++ README.md
@@ -0,0 +1,34 @@
+# ble-throughput-client
+
+Test throughput of Bluetooth Low Energy (BLE). MTU size, DLE size, 2M PHY, etc.
+have to be fine-tuned on the server as BlueZ doesn't expose an API for this.
+
+## Compiling
+
+Install the dependencies:
+
+- Rust
+
+## Usage
+
+The bluetooth device used is given via the `BLUETOOTH_DEVICE` environment
+variable.  
+The server is found through it's published services or a static IP. There's no
+command line switch for this (yet).
+
+```sh
+BLUETOOTH_DEVICE=hci0 cargo run
+```
+
+Running in `--release` mode is encouraged for more accurate results.
+
+## Resources
+
+Send patches and questions to
+[~witcher/bachelor-thesis@lists.sr.ht](https://lists.sr.ht/~witcher/bachelor-thesis).
+
+Instructions for preparing a patch are available at
+[git-send-email.io](https://git-send-email.io/).
+
+Bugs and todo can be found at
+[~witcher/bachelor-thesis](https://todo.sr.ht/~witcher/bachelor-thesis).