README

Create the README its actual readers need, grounded in repository behavior. Accuracy and successful first use come before promotional completeness.

Choose mode and reader job

• Audit — report accuracy, coverage, and usability defects; edit only when requested.
• Repair — update specific weak or stale sections.
• Generate — create a README when none exists or a rewrite is explicitly requested.

Identify the repository type and primary reader job:

• library or SDK adoption;
• CLI installation and first command;
• hosted application setup or contribution;
• service operation and local development;
• monorepo navigation and package ownership;
• standard, dataset, research, or documentation project;
• internal project orientation.