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?
# Comprehensive, well-organized README covering all required sections with correct flag documentation, clear examples, and proper Markdown/code-block usage, though it invents extra details (e.g., MD5, placeholder repo links) not specified in the prompt.
inspect full trace →# Comprehensive, well-organized README covering all required sections with clear examples, though some invented details (hash/line-count logic, placeholder GitHub URL) go beyond the stated scope.
inspect full trace →# All required sections and flags are covered clearly and correctly formatted, though depth default (-1) and hashing algorithm ambiguity feel slightly invented/inconsistent.
inspect full trace →# Covers all required sections and flags but output format section lacks concrete example output, missing sample JSON/text output blocks and a title-only H1 without top-level structure like a Table of Contents or License section.
inspect full trace →