~nytpu/ptim

ref: b96bd38dfcee459c6177a83f7a0878a3bb5a60a2 ptim/README.7 -rw-r--r-- 3.4 KiB
b96bd38dnytpu change link to use local image 5 months ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
.\" To view this file rendered, use `man -l README.7`
.\" To view in other formats, look into mandoc(1) (recommended) or troff(1)
.
.\" Copyright (c) 2021 nytpu <alex@nytpu.com>
.\" SPDX-License-Identifier: MIT
.\" For more license details, see LICENSE or <https://spdx.org/licenses/MIT.html>.
.Dd June 16, 2021
.Dt README 7
.Os nytpu.com
.
.Sh NAME
.Nm ptim
.Nd Pebble Tutorial IMproved watchface
.
.Sh DESCRIPTION
.Nm
is basically the watchface created in
.Lk tutorial-screenshot.png the pebble watchface tutorial ,
but with some improvements.
.
.Pp
The list of changes consists of:
.Bl -enum
.It
The date is included in the top section
.It
The weather display is changed to give high and low temperatures rather than
current conditions.
.It
There is a configuration screen to allow the enabling and disabling of weather,
adding an API key, change temperature units, etc.
.It
Battery bar and positioning of all elements is fixed on non-classic-sized displays;
i.e. the watchface now works on the Pebble Time Round and Pebble Time 2 watches.
.It
Bluetooth disconnected icon is resized and positioned differently, in a less
obtrusive spot.
.El
.
.Sh MOTIVATION
I wanted to learn how to write a Pebble watchface, so I followed the tutorial.
I noticed that there were several areas that could've been improved on and
extended, and which probably would've actually made for good additions to the
tutorial.
The additional modifications and changes may be incorporated into my own
extension to the pebble tutorials.

.Sh INSTALLING
The latest
.Ql .pbw
binary can be downloaded from
.Aq Lk https://nytpu.com/releases/ptim/
without any compilation required.
.
.Ss COMPILING REQUIREMENTS
.Bl -bullet
.It
The
.Lk https://developer.rebble.io/developer.pebble.com/sdk/install/linux/index.html Pebble SDK 4.0 .
Note that
.Lk https://old.reddit.com/r/pebble/comments/jlb5rp/pebble_sdk_on_linux_install_tips/ some special instructions have to be followed on Linux systems .
.It
One of the following Pebble watches:
.Bl -bullet
.It
Pebble
.Dq Aplite
.Pq Pebble Classic & Pebble Steel
.It
Pebble
.Dq Basalt
.Pq Pebble Time & Pebble Time Steel
.It
Pebble
.Dq Chalk
.Pq Pebble Time Round
.It
Pebble
.Dq Diorite
.Pq Pebble 2
.El
.El
.
.Ss COMPILING
First, to download dependencies and compile a
.Ql .pbw :
.Dl pebble build
.Pp
The binary can then be found in
.Pa build/ptim.pbw .
To install on an emulator:
.Dl pebble install --emulator [aplite, basalt, chalk, diorite]
.Pp
To install on an actual watch via the
.Lk https://developer.rebble.io/developer.pebble.com/guides/tools-and-resources/developer-connection/index.html Developer Connection :
.Dl pebble install --phone <phone_ip>
.
.Sh CONTRIBUTING
The upstream URL of this project is
.Aq Lk https://git.nytpu.com/ptim .
Send suggestions, bugs, and other contributions to
.Aq Mt alex@nytpu.com .
For help sending a patch through email, see
.Aq Lk https://git-send-email.io .
.
.Sh COPYRIGHT
.Nm
is Copyright (c) 2021
.An nytpu
.Aq Mt alex@nytpu.com .
.
.Pp
.Nm
is licensed under the terms of the MIT license.
For more information, see
.Pa LICENSE
or
.Aq Lk https://spdx.org/licenses/MIT.html .
.
.Pp
.Nm
uses sample code snippets from
.Lk https://github.com/pebble-examples/watchface-tutorial Pebble's watchface tutorial ,
which is Copyright (c) 2014
.An Pebble Technology
and is licensed under the terms of the MIT license.
For more information, see
.Pa LICENSE
or
.Aq Lk https://github.com/pebble-examples/watchface-tutorial/blob/master/LICENSE.md .