Skip to content

Commit b4d1a38

Browse files
authored
Enhance README with GitHub CodeSpace SDK instructions
Added detailed instructions for using GitHub CodeSpace Cloud SDK, including quick and longer setup guides.
1 parent 79ec433 commit b4d1a38

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,26 @@ All the examples below use the same framework.
3131
Instructions
3232
------------
3333

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.
3554

3655
1. Open https://github.com/codespaces
3756
2. Find green button, "New codespace"
@@ -58,7 +77,9 @@ Alternatively - less typing/clicking:
5877

5978
Stop/Delete codespaces via https://github.com/codespaces
6079

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:
6283

6384
* Display date - using system font
6485
* Display time, updating once per minute- using system font
@@ -75,10 +96,12 @@ Additional options
7596

7697
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.
7798

78-
Alternatively, use a local SDK.
99+
Also, you can use a local SDK.
79100

80101
------------------
81102

103+
## Edit Hints
104+
82105
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:
83106

84107
* If `DEFAULT_TIME_COLOR` is defined it will be used for the default time color.

0 commit comments

Comments
 (0)