From a3dbcd62f6faf70b364ec71f49f9edc9e3847b1c Mon Sep 17 00:00:00 2001
From: Derry Tutt <82726593+everypizza1@users.noreply.github.com>
Date: Sun, 18 Aug 2024 09:18:15 -0500
Subject: Documentation improvements (#2091)

Add documentation about watch faces and applications.
Update getting started documentation.

Co-authored-by: tituscmd <154823939+tituscmd@users.noreply.github.com>
---
 doc/gettingStarted/Applications.md | 99 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 99 insertions(+)
 create mode 100644 doc/gettingStarted/Applications.md

(limited to 'doc/gettingStarted/Applications.md')

diff --git a/doc/gettingStarted/Applications.md b/doc/gettingStarted/Applications.md
new file mode 100644
index 00000000..8ca2b252
--- /dev/null
+++ b/doc/gettingStarted/Applications.md
@@ -0,0 +1,99 @@
+# Applications
+
+InfiniTime has 13 apps on the `main` branch at the time of writing.
+
+## List of apps
+- Stopwatch
+- Alarm
+- Timer
+- Steps
+- Heartrate
+- Music
+- InfiniPaint
+- Paddle
+- 2
+- InfiniDice
+- Metronome
+- Maps
+- Weather
+
+### Stopwatch
+![Stopwatch UI](/doc/gettingStarted/AppsScreenshots/stopwatch.png)
+- Press the Start button (bottom right) to start or stop the timer.
+   - You can also press the side button while the timer is running to pause the timer.
+- Press the Flag button (bottom left) to add a lap.
+- The stopwatch will not yet continue counting time while the app is closed.
+
+### Alarm
+![Alarm UI](/doc/gettingStarted/AppsScreenshots/alarm.png)
+- Ajust the time with the time picker.
+- Press the Info button in the top middle to see time remaning.
+- Use the toggle in the bottom left to turn the alarm on/off.
+- Use the button in the bottom right to change the alarm frequency.
+   - You can choose between once, daily, or Monday - Friday.
+
+### Timer
+![Timer UI](/doc/gettingStarted/AppsScreenshots/timer.png)
+- Ajust how long the timer should go for with the time picker.
+- Press the Start button at the bottom to start/stop the timer.
+
+### Steps
+![Steps UI](/doc/gettingStarted/AppsScreenshots/steps.png)
+- The total count of steps for the current display will show in the middle of the screen.
+- The Reset button in the bottom middle resets the Trip counter. (Total of all steps taken.)
+- The progress circle shows the percentage of your daily goal completed.
+
+### Heartrate
+![Heartrate UI](/doc/gettingStarted/AppsScreenshots/Heartrate.png)
+- Press Start to start measuring your heartrate.
+    - It may take a bit to get the first measurement.
+
+### Music
+![Music UI](/doc/gettingStarted/AppsScreenshots/Music.png)
+- This app shows currently playing music.
+    - Please note that this app is not very useful without a device connected.
+- Press the button in the center to play/pause, and the buttons on the left and right to go to the previous and next tracks, respectively.
+- Swipe up to get to volume controls.
+
+### InfiniPaint
+![InfiniPaint UI](/doc/gettingStarted/AppsScreenshots/Paint.png)
+- This app does not allow you to swipe from the top to exit, use the side button instead.
+- Draw on the screen to add lines.
+- Hold down in one spot to change paint colors.
+
+### Paddle
+![Paddle UI](/doc/gettingStarted/AppsScreenshots/Pong.png)
+- This app does not allow you to swipe from the top to exit, use the side button instead.
+- Drag your finger to move the paddle.
+- Goal: Don't let the ball go off the left side of the screen.
+
+### 2
+![2 UI](/doc/gettingStarted/AppsScreenshots/2048.png)
+- This app does not allow you to swipe from the top to exit, use the side button instead.
+- Play a game of 2048.
+- Swipe up, down, left, or right tomove the tiles.
+- When two tiles with the same number run into each other, they will add together.
+- Goal: Don't let the screen fill up with tiles, and get to the 2048 tile to win.
+
+### InfiniDice
+![InfiniDice UI](/doc/gettingStarted/AppsScreenshots/Dice.png)
+- Ajust the count to change the number of dice.
+- Ajust the sides to change the number of sides.
+- Press the button at the bottom to roll.
+- The result will be on the right side of the screen.
+
+### Metronome
+![Metronome UI](/doc/gettingStarted/AppsScreenshots/Metronome.png)
+- Ajust the BPM with the circular slider.
+    - A bug currently makes it always snap to 98 BPM.
+- Use the button in the bottom left to start the metronome.
+
+### Maps
+![Maps UI](/doc/gettingStarted/AppsScreenshots/Maps.png)
+- This app shows info from a navigation app.
+    - Please note that this app is not very useful without a device connected.
+
+### Weather
+![Weather UI](/doc/gettingStarted/AppsScreenshots/Weather.png)
+- This app shows weather info.
+    - Please note that this app is not very useful without a device connected.
-- 
cgit v1.2.3-70-g09d2