Documentation improvements (#2091)

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

Co-authored-by: tituscmd <[email protected]>

README.md

@@ -9,6 +9,8 @@ Fast open-source firmware for the [PineTime smartwatch](https://pine64.org/devic
 - [Getting started with InfiniTime](doc/gettingStarted/gettingStarted-1.0.md)
 - [Updating the software](doc/gettingStarted/updating-software.md)
 - [About the firmware and bootloader](doc/gettingStarted/about-software.md)
+- [Available apps](doc/gettingStarted/Applications.md)
+- [Available watch faces](/doc/gettingStarted/Watchfaces.md)
 - [PineTimeStyle Watch face](https://pine64.org/documentation/PineTime/Watchfaces/PineTimeStyle)
   - [Weather integration](https://pine64.org/documentation/PineTime/Software/InfiniTime_weather/)
 
@@ -35,7 +37,7 @@ Fast open-source firmware for the [PineTime smartwatch](https://pine64.org/devic
 
 ### Contributing
 
-- [How to contribute?](CONTRIBUTING.md)
+- [How to contribute](CONTRIBUTING.md)
 - [Coding conventions](doc/coding-convention.md)
 
 ### Build, flash and debug

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.

doc/gettingStarted/Watchfaces.md

@@ -0,0 +1,31 @@
+# Watchfaces
+
+InfiniTime has 6 apps on the `main` branch at the time of writing.
+
+## List of apps
+- Digital
+- Analog
+- PineTimeStyle
+- Terminal
+- Infinineat
+- Casio G7710
+
+### Digital
+![Digital face](/doc/gettingStarted/Watchfaces/Digital.png)
+
+### Analog
+![Analog face](/doc/gettingStarted/Watchfaces/Analog.png)
+
+### PineTimeStyle
+![PineTimeStyle face](/doc/gettingStarted/Watchfaces/PineTimeStyle.png)
+    - You can long-press on the display to change colors, step style, and weather.
+
+### Terminal
+![Terminal face](/doc/gettingStarted/Watchfaces/Terminal.png)
+
+### Infinineat
+![Infinineat face](/doc/gettingStarted/Watchfaces/Infinineat.png)
+    - You can long-press on the display to change colors.
+
+### Casio G7710
+![Casio G7710 face](/doc/gettingStarted/Watchfaces/CasioG7710.png)

doc/gettingStarted/gettingStarted-1.0.md

@@ -14,7 +14,7 @@ You can sync the time using companion apps.
 
 - Gadgetbridge automatically synchronizes the time when you connect it to your watch. More information on Gadgetbridge [here](/doc/gettingStarted/ota-gadgetbridge.md)
 - [Sync the time with NRFConnect](/doc/gettingStarted/time-nrfconnect.md)
-- Sync the time with your browser https://hubmartin.github.io/WebBLEWatch/
+- [Sync the time with your browser](https://hubmartin.github.io/WebBLEWatch/)
 
 You can also set the time in the settings without a companion app. (version >1.7.0)
 
@@ -46,7 +46,7 @@ On the bottom right, you can see how many steps you have taken today.
 ![Settings](ui/settings.jpg)
 
 - Swipe **up** to display the application menus. Apps (stopwatch, music, step, games,...) can be started from this menu.
-- Swipe **down** to display the notification panel. Notification sent by your companion app will be displayed here.
+- Swipe **down** to display the notification panel. Notifications sent by your companion app will be displayed here.
 - Swipe **right** to display the Quick Actions menu. This menu allows you to
   - Set the brightness of the display
   - Start the **flashlight** app

doc/gettingStarted/ota-gadgetbridge.md

@@ -1,29 +1,35 @@
 # Connecting to Gadgetbridge
 
-Launch Gadgetbridge and tap on the **"+"** button on the bottom right to add a new device:
+Launch Gadgetbridge and tap on the menu button in the top left:
 
 ![Gadgetbridge 0](gadgetbridge0.jpg)
 
-Wait for the scan to complete, your PineTime should be detected:
+Press the "Connect new device" button:
 
 ![Gadgetbridge 1](gadgetbridge1.jpg)
 
+Your PineTime should appear on the list. Tap on it.
+
 Tap on it. Gadgdetbridge will pair and connect to your device:
 
 ![Gadgetbridge 2](gadgetbridge2.jpg)
 
 # Updating with Gadgetbridge
 
-Now that Gadgetbridge is connected to your PineTime, use a file browser application and find the DFU file (`pinetime-mcuboot-app-dfu-x.x.x.zip`) you downloaded previously. Tap on it and open it using the Gadgetbridge application/firmware installer:
+Now that Gadgetbridge is connected to your PineTime, press the three dots on the device card:
 
 ![Gadgetbridge 3](gadgetbridge3.jpg)
 
-Read the warning carefully and tap **Install**:
+Now press the "File Installer" button:
 
 ![Gadgetbridge 4](gadgetbridge4.jpg)
 
-Wait for the transfer to finish. Your PineTime should reset and reboot with the new version of InfiniTime!
-
-Don't forget to **validate** your firmware. In the InfiniTime go to the settings (swipe right, select gear icon) and Firmware option and click **validate**. Otherwise after reboot the previous firmware will be used.
+Select the firmware you downloaded (`pinetime-mcuboot-app-dfu-x.x.x.zip`) from the [Releases tab](https://github.com/InfiniTimeOrg/InfiniTime/releases/latest):
 
 ![Gadgetbridge 5](gadgetbridge5.jpg)
+
+Wait for the transfer to finish. There will be a progress bar on both the watch and the phone. Your PineTime should reboot with the new version of InfiniTime!
+
+Don't forget to **validate** your firmware. In the InfiniTime go to the settings (swipe right, select gear icon) and scroll to the Firmware option and click **validate**. Otherwise, after reboot the previous firmware will be used.
+
+![Validate](validate.png)

doc/gettingStarted/updating-software.md

@@ -6,7 +6,7 @@ If you just want to flash or upgrade InfiniTime on your PineTime, this page is f
 
 You can check the InfiniTime version by first swiping right on the watch face to open quick settings, tapping the cogwheel to open settings, swipe up until you find an entry named "About" and tap on it.
 
-![InfiniTime 1.0 version](version-1.0.jpg)
+![InfiniTime 1.14 version](version.png)
 
 PineTimes shipped after June 2021 will ship with the latest version of [the bootloader](https://github.com/JF002/pinetime-mcuboot-bootloader/releases/tag/1.0.0) and [recovery firmware](https://github.com/InfiniTimeOrg/InfiniTime/releases/tag/0.14.1)
 
@@ -49,7 +49,7 @@ Since those resources are not part of the firmware, they need to be flashed and
 Resources are packaged into a single .zip file named `infinitime-resources-x.y.z.zip` (where `x`, `y` and `z` are the version numbers of InfiniTime). 
 You can use the companion app of your choice to flash the resources.
 
-**Note : at the time of writing this page, [Amazfish](https://github.com/piggz/harbour-amazfish) and [ITD](https://gitea.arsenm.dev/Arsen6331/itd) have already integrated this functionality. Other companion apps will hopefully implement it soon!*
+**Note: at the time of writing this page, [Amazfish](https://github.com/piggz/harbour-amazfish) and [ITD](https://gitea.arsenm.dev/Arsen6331/itd) have already integrated this functionality. Other companion apps will hopefully implement it soon!*
 
 ## Amazfish
 Use the `Download file` functionality of Amazfish.