From 3c28c0c9c9a625e663bfbf324b3a58a4fb53eb12 Mon Sep 17 00:00:00 2001
From: Gordon Williams <gw@pur3.co.uk>
Date: Wed, 6 Apr 2022 19:45:27 +0100
Subject: [PATCH] readme

---
 apps/compass/README.md     | 29 +++++++++++++++++++++++++++++
 apps/compass/compass.js    |  4 ++--
 apps/compass/metadata.json |  1 +
 3 files changed, 32 insertions(+), 2 deletions(-)
 create mode 100644 apps/compass/README.md

diff --git a/apps/compass/README.md b/apps/compass/README.md
new file mode 100644
index 000000000..d60192f73
--- /dev/null
+++ b/apps/compass/README.md
@@ -0,0 +1,29 @@
+# Compass
+
+This app uses Bangle.js's built-in magnetometer as a compass.
+
+## Usage
+
+Hold your Bangle.js **face up** (so the display is parallel to the ground),
+and the red arrow will point north, with the heading in degrees printed at
+the top of the screen.
+
+This compass app does not include tilt compensation - so much like a real
+compass you should always keep it face up when taking a reading.
+
+The first time you run the compass after your Bangle has booted (or if
+you move to an area with a substantially different magnetic field) you will
+need to recalibrate your compass (even if a heading is shown).
+
+## Calibration
+
+Press the button next to the `RESET` label on the screen. The North/South marker
+will disappear and a message will appear asking you to rotate the watch 360 degrees.
+
+* Hold the watch face up, so the display is parallel to the ground
+* Rotate it around slowly, all 360 degrees (with the display still parallel to the ground)
+* The `Uncalibrated` message will disappear before you have finished rotating the full 360 degrees - but you should still complete the full rotation in order for the compass to work properly.
+
+Once you've rotated the full 360 degrees your compass should now work fine,
+and calibration is stored between runs of the app. However if you go near
+to a strong magnet you may still need to recalibrate.
diff --git a/apps/compass/compass.js b/apps/compass/compass.js
index ee0d3d8ba..4730111ac 100644
--- a/apps/compass/compass.js
+++ b/apps/compass/compass.js
@@ -38,7 +38,7 @@ Bangle.on('mag', function(m) {
     if (!wasUncalibrated) {
       g.clearRect(0,24,W,48);
       g.setFontAlign(0,-1).setFont("6x8");
-      g.drawString("Uncalibrated\nturn 360° around",M,24+4);
+      g.drawString(/*LANG*/"Uncalibrated\nturn 360° around",M,24+4);
       wasUncalibrated = true;
     }
   } else {
@@ -65,7 +65,7 @@ Bangle.on('mag', function(m) {
 });
 
 g.clear(1);
-g.setFont("6x8").setFontAlign(0,0,3).drawString("RESET", g.getWidth()-5, g.getHeight()/2);
+g.setFont("6x8").setFontAlign(0,0,3).drawString(/*LANG*/"RESET", g.getWidth()-5, g.getHeight()/2);
 setWatch(function() {
   Bangle.resetCompass();
 }, (process.env.HWVERSION==2) ? BTN1 : BTN2, {repeat:true});
diff --git a/apps/compass/metadata.json b/apps/compass/metadata.json
index e24ca4adc..3e3b37f72 100644
--- a/apps/compass/metadata.json
+++ b/apps/compass/metadata.json
@@ -7,6 +7,7 @@
   "screenshots": [{"url":"screenshot_compass.png"}],
   "tags": "tool,outdoors",
   "supports": ["BANGLEJS","BANGLEJS2"],
+  "readme": "README.md",
   "storage": [
     {"name":"compass.app.js","url":"compass.js"},
     {"name":"compass.img","url":"compass-icon.js","evaluate":true}