Add guide for lightning strike distance tool

kylecorry31 · Nov 29, 2023 · bd2411a · bd2411a
1 parent 8ed0b2e
commit bd2411a
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/app/src/main/java/com/kylecorry/trail_sense/tools/guide/infrastructure/Guides.kt b/app/src/main/java/com/kylecorry/trail_sense/tools/guide/infrastructure/Guides.kt
@@ -66,6 +66,11 @@ object Guides {
                     null,
                     R.raw.guide_tool_clouds
                 ),
+                UserGuide(
+                    context.getString(R.string.tool_lightning_title),
+                    null,
+                    R.raw.guide_tool_lightning_stike_distance
+                ),
                 if (Sensors.hasBarometer(context)) UserGuide(
                     context.getString(R.string.guide_barometer_calibration_title),
                     null,

diff --git a/app/src/main/java/com/kylecorry/trail_sense/tools/ui/Tools.kt b/app/src/main/java/com/kylecorry/trail_sense/tools/ui/Tools.kt
@@ -234,7 +234,8 @@ object Tools {
                 R.drawable.ic_torch_on,
                 R.id.action_action_experimental_tools_to_fragmentToolLightning,
                 ToolCategory.Weather,
-                context.getString(R.string.tool_lightning_description)
+                context.getString(R.string.tool_lightning_description),
+                guideId = R.raw.guide_tool_lightning_stike_distance
             ),
             if (prefs.isAugmentedRealityEnabled && hasCompass) Tool(
                 25,

diff --git a/app/src/main/res/raw/guide_tool_lightning_stike_distance.md b/app/src/main/res/raw/guide_tool_lightning_stike_distance.md
@@ -0,0 +1,12 @@
+The Lightning Strike Distance tool calculates how far away a lightning strike is. This helps you know if a storm is approaching or moving away.
+
+## Measuring Distance
+To use:
+
+1. Press the lightning icon immediately after seeing lightning.
+2. Press the thunder icon immediately after hearing thunder.
+3. The distance to the strike will display at the top of the screen.
+
+If lightning is close enough to be dangerous, you will see a warning.
+
+The bottom of the screen shows the distance to the most recent strike. If the current strike distance is less than the last, the storm is likely approaching. If more, the storm is likely moving away.