Documentation/doc clock face #2281
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…k-face Updating documentation branch with latest release.
Helping to update the docs for adding new watch faces. The process has changed a lot it seems. These instructions should be current to the 1.15.0 release.
|
This is a continuation of the work that was done here.. #1302 |
NeroBurner
reviewed
Jun 28, 2025
- Clarify wording in a few places. - Remove file from list that is no longer edited. - Update usage of git checkout to git swtich - Add section with sed replace commands for new watch face. - Remove section that is now handled by sed replacements. - Remove extra newlines.
|
Thank you for the feedback! |
shaleh
reviewed
Sep 16, 2025
|
|
||
| ### Amend Files | ||
|
|
||
| Use sed to update `WatchFaceDigital` in the newly copied files with `WatchFaceNew` as well as update the `WatchFace::Digital` type to `WatchFace::NewType`. |
There was a problem hiding this comment.
No need to be imply this requires sed. You can tell the reader to copy the files and replace the text and then show the sed as a suggestion. Some people will want to do that in their editor or honestly not know the Unix tooling. (yeah, I know, but not everyone loves the terminal like us ....)
shaleh
reviewed
Sep 16, 2025
|
|
||
| ## Amending the Watch Face to Suit | ||
|
|
||
| Start editing and ammended WatchFaceNew.cpp to suit your tastes. To save space on the firmware, use existing fonts. |
There was a problem hiding this comment.
Suggested change
| Start editing and ammended WatchFaceNew.cpp to suit your tastes. To save space on the firmware, use existing fonts. | |
| Start editing WatchFaceNew.cpp to suit your tastes. To save space on the firmware, use existing fonts. |
No need to talk about amending here. Editing covers all of the needed work.
shaleh
reviewed
Sep 16, 2025
|
|
||
| If you already have a `build/CMakeCache.txt` it will prevent your new watch face from being included in the build, so you will need to pass the `--fresh` argument to `cmake` or remove `build/CMakeCache.txt` before building. (The value of DEFAULT_WATCHFACE_TYPES is cached.) | ||
|
|
||
| ## Amending the Watch Face to Suit |
There was a problem hiding this comment.
Suggested change
| ## Amending the Watch Face to Suit | |
| ## Editing the Watch Face to Suit |
shaleh
reviewed
Sep 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just trying to pitch in on the documentation update and make things current.
This should be everything I had to do recently to get a new watch face working?
Any feedback is appreciated.