From 11962c33721c3347766148cb7f2de1dc5c86dc28 Mon Sep 17 00:00:00 2001
From: Greg <gmp@wow.st>
Date: Wed, 27 Nov 2019 11:52:18 -0500
Subject: [PATCH] add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8efaaaa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# 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
+```