Skip to content

docs: rewrite the README around per-vendor SoC tables - #98

Merged
dimerr merged 1 commit into
openipcfrom
docs/readme-rewrite
Nov 3, 2026
Merged

dimerr merged 1 commit into
openipcfrom
docs/readme-rewrite

Conversation

@dimerr

@dimerr dimerr commented Nov 3, 2026

Copy link
Copy Markdown
Collaborator

Rewrites README.md on openipc so it reads as user documentation instead of ten copies of the same per-family text.

Layout

  • Contents, then Supported vendors: one row per vendor with a link to its section, source branch, releases page and CI badge. No SoC counts to keep up to date.
  • One section per vendor: a SoC | CPU | RAM | Flash | Notes table, followed by all of that vendor's quirks: GK710x programmer images, Allwinner SD boot, Anyka vendor uImage entry, Xiongmai write protection, extra toolchains, and SD recovery file-name limits.
  • Common sections, written once: images, NOR/NAND flash layout, what happens at boot (recovery check, first-start env save, firmware scan, autoboot/bootfail reflash, failsafe boot-loop guard), update commands and variables, recovery over TFTP and SD/USB (script.txt, *.img uImage wrappers with mkimage examples), building, CI.

Fixed against the branches

  • Adds the Xiongmai V200 parts (xm530v200, xm533, xm535d1/d2/w1), which are already built and released.
  • Anyka and SigmaStar do have SD recovery: both branches enable MMC.
  • Documents that anyka, novatek, allwinner and sigmastar still use the older recovery code, which only picks up fixed *.img names.

Known gaps
RAM is "—" for hi3516dv200, gk7201v200/v300, gk7605v100, gk7205v500/v510/v530, gk7206v11a, hi3516ev100 and hi3518ev100. Some other in-package HiSilicon/Goke sizes come from general knowledge rather than a tree.

Docs only; no workflow changes.

The README repeated the same build, image and CI paragraphs for every
family and had drifted from the branches: it missed the Xiongmai V200
parts, and said Anyka and SigmaStar have no SD recovery.

Now: a vendor index with links to each section and its releases, one
section per vendor (a SoC | CPU | RAM | Flash | Notes table plus all of
that vendor's quirks), then the common parts once: images, flash
layout, the boot sequence, the update commands, TFTP and SD recovery
(script.txt, *.img wrappers), building and CI.

RAM for several HiSilicon/Goke parts is still unknown ("—").
@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can tweak Display settings with a live preview to see your comment before it ships

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Rewrite README as a vendor-indexed U-Boot guide

📝 Documentation 🕐 20-40 Minutes

Grey Divider

AI Description

• Replace repeated family descriptions with a vendor index, SoC tables, and shared user guides.
• Document Xiongmai V200 parts and correct Anyka and SigmaStar SD recovery guidance.
• Consolidate image, flash, boot, update, recovery, build, and CI instructions.
Diagram

graph TD
  Reader["README reader"] --> Index["Vendor index"] --> Tables["Vendor SoC tables"] --> Guides["Shared guides"] --> Recovery["Recovery instructions"]
  Index --> CI["Releases and CI"]
Loading
High-Level Assessment

Keep the vendor tables and common procedures in one indexed README. Separate vendor documents could shorten the entry page, but would make the shared operating guidance harder to find and maintain; this change is documentation-only.

Files changed (1) +408 / -608

Documentation (1) +408 / -608
README.mdOrganize U-Boot documentation by vendor and shared procedure +408/-608

Organize U-Boot documentation by vendor and shared procedure

• Replaces repeated family text with a linked vendor index, SoC specification tables, and consolidated guides for images, flash layout, boot, updates, recovery, building, and CI. Adds the built Xiongmai V200 parts, corrects Anyka and SigmaStar SD recovery guidance, and identifies vendors whose recovery accepts only fixed image names. Unknown RAM values remain marked as such.

README.md

@dimerr
dimerr merged commit f613bac into openipc Nov 3, 2026
41 checks passed
@dimerr
dimerr deleted the docs/readme-rewrite branch November 3, 2026 19:27
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