From c67f9bf16d57ded4072ce9e2674fd5c85bf0b660 Mon Sep 17 00:00:00 2001 From: Greg Date: Mon, 16 Dec 2019 08:42:11 -0500 Subject: [PATCH] Doc updates. --- README.md | 32 ++++++++++++++++++++++++++++++++ hrm/README.md | 24 ------------------------ 2 files changed, 32 insertions(+), 24 deletions(-) create mode 100644 README.md delete mode 100644 hrm/README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d01224d --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# HRM + +An example heart rate monitor app for Android and MacOS using [git.wow.st/gmp/ble](https://git.wow.st/gmp/ble) and [Gio](https://gioui.org). + +The MacOS implementation uses a Core Bluetooth binding created by +[NSWrap](https://git.wow.st/gmp/nswrap). On Android, Martijn van Welie's +Blessed library is used to simplify access to the Bluetooth Low-Energy +hardware. If you need to re-compile the Blessed library for any reason, you +can use `go generate` from the `depjars` directory. To do that, you will need +to have `gradle`, an Android SDK, and who knows what else installed on your +machine. + +## MacOS: + +``` +git clone https://git.wow.st/gmp/hrm +cd hrm/hrm +go build +./hrm +``` + +## Android: + +The `gogio` command from `gioui.org/cmd/gogio` must be installed to build +an Android APK. + +``` +git clone https://git.wow.st/gmp/hrm +cd hrm/hrm +gogio -target android . +adb install -r hrm.apk +``` diff --git a/hrm/README.md b/hrm/README.md deleted file mode 100644 index 8efaaaa..0000000 --- a/hrm/README.md +++ /dev/null @@ -1,24 +0,0 @@ -# HRM - -An example heart rate monitor app for Android and MacOS using [git.wow.st/gmp/ble](https://git.wow.st/gmp/ble) and [Gio](https://gioui.org). - -## MacOS: - -``` -go get git.wow.st/gmp/hrm -cd ~/go/src/git.wow.st/gmp/hrm -go build -./hrm -``` - -## Android: - -The `gogio` command from `gioui.org/cmd/gogio` must be installed to build -an Android APK. - -``` -go get git.wow.st/gmp/hrm -cd ~/go/src/git.wow.st/gmp/hrm -gogio -target android . -adb install -r hrm.apk -```