Doc updates.

This commit is contained in:
Greg 2019-12-16 08:42:11 -05:00
parent 9484ffac99
commit acf0e7efe9
2 changed files with 34 additions and 24 deletions

34
README.md Normal file
View File

@ -0,0 +1,34 @@
# 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](https://github.com/weliem/blessed-android) library is used to
simplify access to the Bluetooth Low-Energy hardware.
## 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
```
The compiled Java code for the Android implementation is pre-packaged in
jar files. If you want to, you can re-compile these dependencies by running
`go generate` from the `depjars` directory. You will need to have `gradle`,
an Android SDK, and who knows what else installed on your machine.

View File

@ -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
```