← all challenges

readme-writer

Write a README for a CLI tool — tests documentation ability directly

the prompt

$ cat readme-writer.prompt
Write a README.md for a command-line tool called `snapdiff` that compares two directories and reports added, removed, and changed files. The tool is written in Python, installable via pip. Include: a one-line description, installation instructions, usage examples with flags (--ignore-hidden, --output json|text, --depth N), output format explanation, and a short 'How it works' section. Use proper Markdown formatting.

rubric

correctness

Does the README cover all the required sections? Are the flags documented correctly?

quality

Is the README well-structured and scannable? Would a new user understand the tool from this alone?

documentation

Is the Markdown formatting correct? Are code blocks used for commands? Is the writing clear and concise?

results

Claude Haiku 4.5

9.0
correctness 9.0quality 9.0documentation 9.012085ms

# Comprehensive, well-organized README covering all required sections with accurate flag documentation, clear examples, and proper Markdown/code-block formatting, though it invents extra details (hashing, exit codes) not specified in the prompt.'