research-codebase-readme-writer
README Writer for Research Repos
The README has one job: let someone (including you in 6 months) reproduce the main result without asking a question.
Everything else is secondary.
Two failure modes to prevent
Failure mode 1 — The decorative README. Has a title, a usage example, and a citation block. Looks like a README. Can't actually reproduce Table 2 because the data download step is missing, the argument name changed, and nobody knows which script maps to which paper claim.
Failure mode 2 — The motivation README. Two paragraphs on why the problem matters, zero information on where the dataset goes or how long training takes. Written for a reader of the paper, not a runner of the code.
What to produce
Generate a README.md with exactly these sections, in this order. Skip a section only if it genuinely doesn't apply — don't pad.