How hackathon judges read your README
A placeholder guide to check the layout: headings, lists, code, quotes and links in the guide template.
By Niket Shah
This is a placeholder. It's here so the guide layout can be checked before the real guides are written: every element a guide is likely to use appears once below.
What the judges look at first
Most judges open the README before the code. They read the first screen, look for a demo link, and skim the feature list for anything they can check.
- A one-sentence description of what it is
- A demo link that loads
- Claims the code backs up
A heading one level down
A paragraph with bold text, italic text, inline code and a link to the sample session.
- Paste the repo
- Answer three questions
- Read the review
Every claim in your README gets checked against your code.
export function estimateWait(position: number) {
return position * 6; // minutes, flat for now
}
That's the end of the placeholder.
wouldthiswin