Write a README for a CLI tool — tests documentation ability directly
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.
Does the README cover all the required sections? Are the flags documented correctly?
Is the README well-structured and scannable? Would a new user understand the tool from this alone?
Is the Markdown formatting correct? Are code blocks used for commands? Is the writing clear and concise?
# The README fully covers every requested section and flag with clear examples, accurate output explanations, concise prose, and polished, scannable Markdown.
inspect full trace →# The README fully covers every required section and flag with clear examples, accurate output semantics, concise explanations, and polished Markdown structure.
inspect full trace →