search

sqfmi / Watchy

Watchy - An Open Source E-Ink Smartwatch
http://www.sqfmi.com
MIT License
2k stars 334 forks source link

Add an "About Watchy" menu item. #139

Closed rastagraffix closed 2 years ago

rastagraffix commented 2 years ago

This replaces "Check Battery" and adds the following info:

The firmware version is #defined in Watchy.h. There might be a way to do this that's friendlier to the library release process, but I'll leave that up to the people who actually build the releases.

I plan to extend the About menu with some radio-related info as I work on getting BLE pairing working with my iPhone.

rastagraffix commented 2 years ago

Some notes on versioning ...

I just noticed a 1.3.2 release snuck out just before my pull request, which brands the firmware as 1.3.1. To keep things in sync the release cycle needs a small tweak ...

Assuming version 1.3.3 is about to be released, the last step before building the release is to update the version in Watchy.h to "1.3.3", then run the build. If the build comes out clean, immediately tag the repo with "v1.3.3", then push to github. When the push completes, immediately change the version string in Watchy.h to "1.3.4dev" (or whatever the next anticipated release number is) and commit. Note the "dev" suffix -- this indicates a build off the head.

Following this convention makes it easy to identify the origin of the firmware. If it has a bare version number (e.g. 1.3.3) we know it corresponds to the v1.3.3 tag in the repo. Anything with a suffix on the version number was built from the head. It's not perfect, but it saves a lot of time triaging PRs.

sqfmi commented 2 years ago

This is awesome, thanks! I merged this PR into the dev branch and made some small changes (e.g. moved the version number to config.h instead).