Skip to content

Commit a3dbcd6

Browse files
88572tituscmd
andauthored
Documentation improvements (#2091)
Add documentation about watch faces and applications. Update getting started documentation. Co-authored-by: tituscmd <154823939+tituscmd@users.noreply.github.com>
1 parent 4fddf93 commit a3dbcd6

33 files changed

Lines changed: 150 additions & 12 deletions

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Fast open-source firmware for the [PineTime smartwatch](https://pine64.org/devic
99
- [Getting started with InfiniTime](doc/gettingStarted/gettingStarted-1.0.md)
1010
- [Updating the software](doc/gettingStarted/updating-software.md)
1111
- [About the firmware and bootloader](doc/gettingStarted/about-software.md)
12+
- [Available apps](doc/gettingStarted/Applications.md)
13+
- [Available watch faces](/doc/gettingStarted/Watchfaces.md)
1214
- [PineTimeStyle Watch face](https://pine64.org/documentation/PineTime/Watchfaces/PineTimeStyle)
1315
- [Weather integration](https://pine64.org/documentation/PineTime/Software/InfiniTime_weather/)
1416

@@ -35,7 +37,7 @@ Fast open-source firmware for the [PineTime smartwatch](https://pine64.org/devic
3537

3638
### Contributing
3739

38-
- [How to contribute?](CONTRIBUTING.md)
40+
- [How to contribute](CONTRIBUTING.md)
3941
- [Coding conventions](doc/coding-convention.md)
4042

4143
### Build, flash and debug

doc/gettingStarted/Applications.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# Applications
2+
3+
InfiniTime has 13 apps on the `main` branch at the time of writing.
4+
5+
## List of apps
6+
- Stopwatch
7+
- Alarm
8+
- Timer
9+
- Steps
10+
- Heartrate
11+
- Music
12+
- InfiniPaint
13+
- Paddle
14+
- 2
15+
- InfiniDice
16+
- Metronome
17+
- Maps
18+
- Weather
19+
20+
### Stopwatch
21+
![Stopwatch UI](/doc/gettingStarted/AppsScreenshots/stopwatch.png)
22+
- Press the Start button (bottom right) to start or stop the timer.
23+
- You can also press the side button while the timer is running to pause the timer.
24+
- Press the Flag button (bottom left) to add a lap.
25+
- The stopwatch will not yet continue counting time while the app is closed.
26+
27+
### Alarm
28+
![Alarm UI](/doc/gettingStarted/AppsScreenshots/alarm.png)
29+
- Ajust the time with the time picker.
30+
- Press the Info button in the top middle to see time remaning.
31+
- Use the toggle in the bottom left to turn the alarm on/off.
32+
- Use the button in the bottom right to change the alarm frequency.
33+
- You can choose between once, daily, or Monday - Friday.
34+
35+
### Timer
36+
![Timer UI](/doc/gettingStarted/AppsScreenshots/timer.png)
37+
- Ajust how long the timer should go for with the time picker.
38+
- Press the Start button at the bottom to start/stop the timer.
39+
40+
### Steps
41+
![Steps UI](/doc/gettingStarted/AppsScreenshots/steps.png)
42+
- The total count of steps for the current display will show in the middle of the screen.
43+
- The Reset button in the bottom middle resets the Trip counter. (Total of all steps taken.)
44+
- The progress circle shows the percentage of your daily goal completed.
45+
46+
### Heartrate
47+
![Heartrate UI](/doc/gettingStarted/AppsScreenshots/Heartrate.png)
48+
- Press Start to start measuring your heartrate.
49+
- It may take a bit to get the first measurement.
50+
51+
### Music
52+
![Music UI](/doc/gettingStarted/AppsScreenshots/Music.png)
53+
- This app shows currently playing music.
54+
- Please note that this app is not very useful without a device connected.
55+
- 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.
56+
- Swipe up to get to volume controls.
57+
58+
### InfiniPaint
59+
![InfiniPaint UI](/doc/gettingStarted/AppsScreenshots/Paint.png)
60+
- This app does not allow you to swipe from the top to exit, use the side button instead.
61+
- Draw on the screen to add lines.
62+
- Hold down in one spot to change paint colors.
63+
64+
### Paddle
65+
![Paddle UI](/doc/gettingStarted/AppsScreenshots/Pong.png)
66+
- This app does not allow you to swipe from the top to exit, use the side button instead.
67+
- Drag your finger to move the paddle.
68+
- Goal: Don't let the ball go off the left side of the screen.
69+
70+
### 2
71+
![2 UI](/doc/gettingStarted/AppsScreenshots/2048.png)
72+
- This app does not allow you to swipe from the top to exit, use the side button instead.
73+
- Play a game of 2048.
74+
- Swipe up, down, left, or right tomove the tiles.
75+
- When two tiles with the same number run into each other, they will add together.
76+
- Goal: Don't let the screen fill up with tiles, and get to the 2048 tile to win.
77+
78+
### InfiniDice
79+
![InfiniDice UI](/doc/gettingStarted/AppsScreenshots/Dice.png)
80+
- Ajust the count to change the number of dice.
81+
- Ajust the sides to change the number of sides.
82+
- Press the button at the bottom to roll.
83+
- The result will be on the right side of the screen.
84+
85+
### Metronome
86+
![Metronome UI](/doc/gettingStarted/AppsScreenshots/Metronome.png)
87+
- Ajust the BPM with the circular slider.
88+
- A bug currently makes it always snap to 98 BPM.
89+
- Use the button in the bottom left to start the metronome.
90+
91+
### Maps
92+
![Maps UI](/doc/gettingStarted/AppsScreenshots/Maps.png)
93+
- This app shows info from a navigation app.
94+
- Please note that this app is not very useful without a device connected.
95+
96+
### Weather
97+
![Weather UI](/doc/gettingStarted/AppsScreenshots/Weather.png)
98+
- This app shows weather info.
99+
- Please note that this app is not very useful without a device connected.
4.43 KB
Loading
4.59 KB
Loading
4.27 KB
Loading
3.19 KB
Loading
8.83 KB
Loading
6.13 KB
Loading
3.06 KB
Loading
2.92 KB
Loading

0 commit comments

Comments
 (0)