Symptom
No README.md exists at all.
A repo with no usable README cannot be picked up later — by a collaborator or by
future-you — without reading the source to work out what it does.
Expected vs actual
Expected: README.md states what the project is, the hardware/services it talks to,
how to set it up, and how to run or deploy it.
Actual: No README.md exists at all.
Where
README.md at repo root.
Notes
Per the github-first rule, in-repo README.md and docs/ are the source of truth
and get code review; the wiki is published from them. This is the upstream of that.
Do not include tokens, internal IPs, or device serials — see the no-secrets rule.
Symptom
No README.md exists at all.
A repo with no usable README cannot be picked up later — by a collaborator or by
future-you — without reading the source to work out what it does.
Expected vs actual
Expected:
README.mdstates what the project is, the hardware/services it talks to,how to set it up, and how to run or deploy it.
Actual: No README.md exists at all.
Where
README.mdat repo root.Notes
Per the
github-firstrule, in-repoREADME.mdanddocs/are the source of truthand get code review; the wiki is published from them. This is the upstream of that.
Do not include tokens, internal IPs, or device serials — see the
no-secretsrule.