write-readme
Write README
Write for someone discovering the software: help them understand what it does, whether it fits their needs, and how to try it. Organize the README around what the reader can accomplish. Keep the depth appropriate to the intended users; developer tools may need code examples, while an app may need a short walkthrough.
Establish the facts
Read the existing README and inspect the relevant entry points, examples, tests, and package or build metadata. Establish the software's purpose, audience, main capabilities, and shortest usable starting path. Trace claims and example syntax to the implementation or maintained project documentation. Describe available behavior; distinguish planned functionality when the user asks to include it.
Use the requested language, or preserve the README's language when unspecified. Ask only about gaps that materially affect the result and cannot be resolved from the project. If information is unavailable, omit unsupported claims and report the gap to the user rather than inserting invented details.