mkl-write-readme

Lead with the concrete task the project helps users complete, then give the shortest path to an observable result: prerequisites, installation, one representative command, and expected output. Base every command on inspected repository evidence rather than assumptions.

Inspect the repository's entry points, package metadata, and examples to determine the correct command, then label it as unverified. Never present expected output as proof that a command was executed.

Document supported environments, important constraints, and where deeper documentation lives. Preserve existing useful links, project identity, and license information while avoiding invented badges or endorsements.

This Skill targets project landing documentation and onboarding, not long tutorials or release notes. For changelog generation or in-depth guides, use documentation tools designed for those formats.

Quickstarts fail when authors invent package registry names, versions, or download links not present in the repository. Verifying commands in a disposable directory or explicitly labeling unverified steps prevents this.