← ClaudeAtlas

judge-ready-readmelisted

The README-as-landing-page structure -- live demo first, why-this-tech placed before any badges table, security model, optional demo-data and disclosure sections
rogerjeasy/win-hackathon · ★ 0 · AI & Automation · score 60
Install: claude install-skill rogerjeasy/win-hackathon
# A README a judge actually reads first Judges are not required to test the project and may judge from the text description, images, and video alone. The README is often the first thing they open. Structure it as a landing page, not a wiki. ## Order, top to bottom 1. **Live demo link, first.** Before any badge row. 2. **The tech-thesis quote, as the first blockquote after the title -- before any badges or results table.** Not buried in "How we built it." Both `karma` and `kintwadi` place it here: Karma's "Built on Google Cloud's Vertex AI Agent Builder…" is the first prose after the title block, before its own results table. Kintwadi's "Which AWS database, and why" is section two, immediately after "What it is." This is the same finding `sponsor-tech-thesis` records about Devpost's own submission text (top-level heading, high in the document) — the README gets the identical treatment, one screen earlier than the form. 3. **What it is / the problem**, in plain language. 4. **Features.** 5. **Security** — point at `AGENTS.md`, do not restate its invariants. A judge who wants the detail can open it; the README's job is to say the model exists and is enforced. 6. **Tech stack.** ## Optional sections - **Note on demo data** — when any part of the demo uses illustrative or synthetic data (a clinical knowledge base, a fabricated dataset), say so plainly, once, near the end. Kintwadi does this for its drug-interaction check. - **Hackathon Disclosure**