Skip to content

docs: rewrite the README for judges - #15

Merged
dadadave80 merged 3 commits into
mainfrom
docs/polish-readme
Nov 15, 2026
Merged

dadadave80 merged 3 commits into
mainfrom
docs/polish-readme

Conversation

@dadadave80

@dadadave80 dadadave80 commented Nov 14, 2026 •

Copy link
Copy Markdown
Owner

Rewrites the README so a judge can understand, try and check Familiar from one page.

  • Opens with the play link and a short statement of the idea.
  • Lists what makes the game different, each point with the command that checks it.
  • Gives try-it steps in do-this, see-that form, ending with make judge and make break.
  • Adds the season contract (Bram's pricing formula, till, wish purse) and a plain list of limits.
  • Adds the hackathon notes: start date, libraries, AI assistance, artwork provenance, license.
  • Links the hackathon-submission tag, which marks main at the deadline, and the comparison from that tag to main.
  • Corrects docs/ARCHITECTURE.md, which still said the season contract was not deployed.

Docs only.

@vercel

vercel Bot commented Nov 14, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
familiar Ready Ready Preview Nov 15, 2026 5:01pm UTC

@dadadave80 dadadave80 changed the title docs: add the play link and try-it steps to the README docs: rewrite the README for judges Nov 15, 2026
@dadadave80
dadadave80 merged commit 3a405ce into main Nov 15, 2026
3 checks passed
@dadadave80
dadadave80 deleted the docs/polish-readme branch November 15, 2026 17:07

This branch was successfully deployed

1 active deployment
Preview — 6f7b8c36 Deployed Nov 15, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant