You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-3Lines changed: 26 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,26 @@ All the examples below use the same framework.
31
31
Instructions
32
32
------------
33
33
34
-
For GitHub CodeSpace Cloud SDK usage:
34
+
### GitHub CodeSpace Cloud SDK
35
+
36
+
#### Quick GitHub CodeSpace Cloud SDK
37
+
38
+
1. Open https://github.com/clach04/pebble_watchface_framework/ in web browser
39
+
2. Click the green "Use this template" button (top right), "Open in a codespace"
40
+
3. Wait.....
41
+
4. Open source file (e.g. watchface.c), see problems pane fill with a couple
42
+
of errors. Right-click on the first one,
43
+
`#include errors detected. Please update your includePath. Squiggles are disabled for this translation unit (/workspaces/codespaces-pebble/myfirstproject/src/c/myfirstproject.c).`,
44
+
right click and edit include path `Edit "includePath" setting`.
45
+
Then close the new edit view.
46
+
This will create a .vscode file with the correct path, a preset one is not
47
+
included to avoid local SDK / VScode conflicts
48
+
(TODO: consider updating the setup script to handle this).
49
+
5. Click the Pebble button in the left-hand bar, and use run buttons to build and run in the emulator.
50
+
51
+
#### Longer GitHub CodeSpace Cloud SDK
52
+
53
+
These are generic instructions and work for any codespace template.
35
54
36
55
1. Open https://github.com/codespaces
37
56
2. Find green button, "New codespace"
@@ -58,7 +77,9 @@ Alternatively - less typing/clicking:
58
77
59
78
Stop/Delete codespaces via https://github.com/codespaces
60
79
61
-
Then start adding options and resources. By default, the empty framework will:
80
+
## Edit and customize
81
+
82
+
Start adding options and resources. By default, the empty framework will:
62
83
63
84
* Display date - using system font
64
85
* Display time, updating once per minute- using system font
@@ -75,10 +96,12 @@ Additional options
75
96
76
97
https://www.stef.be/dpaint/ is a good web/cloud-based bitmap editor. Upload images to `resources` directory and update `package.json`. See linked examples/samples for images.
77
98
78
-
Alternatively, use a local SDK.
99
+
Also, you can use a local SDK.
79
100
80
101
------------------
81
102
103
+
## Edit Hints
104
+
82
105
In an ideal situation, `watchface.c` and `watchface.h` should not need editing *ever*. There may be cases where `main.c` needs editing. Most of the time `watch_config.h` is the only file that will need editing. `watch_config.h` options:
83
106
84
107
* If `DEFAULT_TIME_COLOR` is defined it will be used for the default time color.
0 commit comments