Skip to content

docs: logo, README entry point, and firmware deep dive - #4

Merged
timfromhcs merged 1 commit into
masterfrom
docs/readme-logo
Oct 29, 2026
Merged

timfromhcs merged 1 commit into
masterfrom
docs/readme-logo

Conversation

@timfromhcs

Copy link
Copy Markdown
Owner

What changed

  • Logo: an original mark in docs/assets/logo.svg, with a dark-mode variant selected via <picture>. It is not the Bitaxe project's artwork.
  • README is now an entry point: logo, badges for the Build Firmware and Unit Test workflows and the latest release, a contents list, and a note that the project is not affiliated with Bitaxe.
  • Deep dive moved to docs/FIRMWARE_DEEP_DIVE.md: what the fork changes, measurements, hardware and architecture. The text and its evidence labels are unchanged. Links were rewritten for the new location, and every local link in both files was checked.
  • Corrected in the status section: the BM1366 units are on v4.0.2-rc1 now, so the "left on older firmware" sentence is gone. Their v4.0.0 validation figures stay labelled as v4.0.0.
  • Clarified: the DHCP fallback replays only a complete earlier lease, and the static fallback exists but is off unless set.

What is not changed

  • No firmware code. No claims were added beyond what the repository already documents.
  • v4.0.2-rc1 is still not published as a release.

For the reviewer

  • The logo is plain SVG and parses as XML. I have not checked how it renders on GitHub's light and dark pages; please look at it there.

🤖 Generated with Claude Code

- Adds an original logo (docs/assets/logo.svg, plus a dark-mode variant
  picked via <picture>). It is not the Bitaxe project's artwork.
- README is now the entry point: logo, badges for the build and unit-test
  workflows and the latest release, a contents list, and an explicit note
  that the project is not affiliated with Bitaxe.
- The long firmware write-up (what changes, measurements, hardware,
  architecture) moves to docs/FIRMWARE_DEEP_DIVE.md with its labels intact.
  Links are rewritten for the new location; every local link was checked.
- Status: the BM1366 units are now on v4.0.2-rc1, so the sentence that they
  were left on older firmware is replaced. Their v4.0.0 validation figures stay
  labelled as v4.0.0.
- Clarifies the DHCP fallback (replays only a complete earlier lease; the
  static fallback exists but is off unless set) and the OTA behaviour wording.

Co-Authored-By: Claude Haiku 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Test Results

  2 files  ±0    2 suites  ±0   1s ⏱️ ±0s
136 tests ±0  136 ✅ ±0  0 💤 ±0  0 ❌ ±0 
138 runs  ±0  138 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit dc686ae. ± Comparison against base commit 1e0cfa0.

♻️ This comment has been updated with latest results.

@timfromhcs
timfromhcs merged commit 21f543c into master Oct 29, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant