rewrite the README #6

Merged
cristhian merged 1 commits from readme-rewrite into main 2026-09-15 09:58:11 +00:00
1 Commits
Author SHA1 Message Date
cristhian 8c3b3aac92 rewrite the README
validate / validate (pull_request) Successful in 59m14s
It had drifted out of agreement with itself. The manifest section still said
`image` is std/core/v1/UInt8 and depth and camera_info are std/core/v1/Float32,
four lines above a table correctly saying both are std/media/v1/Image, and the
worked example for a producer showed the flat-buffer form the node moved away
from. Someone following it would have written a producer that fails validate.

It was also close to twice the length of the one next door, mostly rationale:
why a dataflow carries no strict_types, how a producer migrates, what a git:
node needs and why. That belongs in the file it explains or in the commit that
made the decision, not in front of someone trying to wire a node.

1007 words, from 1749. Every encoding, environment variable and CLI flag in it
was checked against the code.
2026-09-15 06:56:49 -03:00