Document flashing a released factory image without building#3
Merged
Conversation
The README only covered building from source; the release assets' factory.bin was mentioned in passing with a bare esptool hint. Add a 'Flashing a release' section walking through downloading the factory image, driver setup, esptool / web-flasher usage at offset 0x0, the captive-portal first boot, and OTA for subsequent releases. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BQw2WTXY23m36FD1sWEzGh
There was a problem hiding this comment.
Pull request overview
Improves onboarding by expanding the README’s Setup instructions to include a “flash a prebuilt release” path (no local build), while keeping “build from source” as the customization path.
Changes:
- Reworks the Setup introduction to present “flash a release” vs. “build from source” as two entry paths.
- Adds a “Flashing a release (no build needed)” section with step-by-step flashing guidance (esptool + web flasher) and first-boot behavior.
- Updates the “CI builds and releases” section to cross-reference the new flashing instructions.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+27
to
+30
| Each [GitHub release](../../releases/latest) has a | ||
| `esp32worldclock-<tag>-factory.bin` attached: a full flash image (bootloader + | ||
| partition table + app) that brings a brand-new ESP32 to a working clock in one | ||
| step. |
Comment on lines
+46
to
+48
| Replace `COM3` with your port. No install needed alternative: open | ||
| [Espressif's web flasher](https://espressif.github.io/esptool-js/) in | ||
| Chrome/Edge, connect, and program the same file at address `0x0`. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The README only covered getting firmware onto a device by building from source; the release assets'
factory.binwas mentioned only in passing with a bareesptool.py write_flash 0x0 ...hint under "CI builds and releases".This adds a "Flashing a release (no build needed)" section under Setup that walks a new user through:
esp32worldclock-<tag>-factory.binfrom the latest GitHub release0x0withesptool— plus a zero-install alternative using Espressif's browser-based web flasheresp32Projectcaptive portal opens)erase_flashfor recovering a device with leftover settings-ota.bin/ web updater path for subsequent cable-free updatesThe Setup intro is reworked to present "flash a release" vs. "build from source" as the two entry paths, and the "CI builds and releases" section now cross-references the new instructions instead of the inline esptool one-liner. Flash offset and asset names match what
.github/workflows/build.ymlpublishes.🤖 Generated with Claude Code
https://claude.ai/code/session_01BQw2WTXY23m36FD1sWEzGh
Generated by Claude Code