From: Jeremy O'Brien <neutral@fastmail.com>
Date: Wed, 11 Jan 2023 19:54:52 +0000 (-0500)
Subject: add tarot face documentation as per the new template.h
X-Git-Url: https://git.earman.xyz/?a=commitdiff_plain;h=7a41c95d81ddc9b82dc2b0893dd3ae60cb7aa4b4;p=sensor-watch.git

add tarot face documentation as per the new template.h
---

diff --git a/movement/watch_faces/complication/tarot_face.h b/movement/watch_faces/complication/tarot_face.h
index e9ffc89..9ff03eb 100644
--- a/movement/watch_faces/complication/tarot_face.h
+++ b/movement/watch_faces/complication/tarot_face.h
@@ -27,6 +27,21 @@
 
 #include "movement.h"
 
+/*
+ * Tarot card watch face
+ *
+ * Draw from a deck of the 22 major arcana tarot cards
+ *
+ * When "Draw" is shown:
+ * - Light button: cycle # of cards to draw
+ * - Alarm button: shuffle deck and draw cards
+ *
+ * After cards are drawn/showing:
+ * - Light button: view the next drawn card
+ * - Alarm button: shuffle and re-draw new cards
+ * - Light button (long press): go back to Draw screen. For choosing different # of cards to draw.
+ */
+
 #define MAX_CARDS_TO_DRAW 10
 
 typedef struct {