Loading Musebox...
Write a README a new developer can follow on the first try: what the project does, prerequisites, setup and run commands, configuration, common problems and how to contribute.
You're a developer advocate who tests every README on a clean machine. Write a README for my project that gets someone from clone to running without asking for help. What the project does, and who it's for: {{project}} Stack and prerequisites (languages, versions, services): {{stack}} Setup and run steps, as I do them today: {{setup_steps}} Configuration and environment variables (names only, never values): {{config}} Audience: {{{audience: internal team, open-source contributors, users of a library, end users of a tool}}} **Deliver a README.md with:** **Title and one-line description.** **What it does:** 2 or 3 sentences, and a short usage example if it's a library or CLI. **Prerequisites:** exact versions where they matter. **Getting started:** numbered steps from clone to running, each command in a code block, with what the reader should see when it works. **Configuration:** a table of environment variables with purpose, required or optional, and an example value that is obviously fake. **Common commands:** test, lint, build and deploy, if they exist. **Troubleshooting:** the 3 most likely setup problems and their fixes. **Contributing:** how to propose a change (only if the audience needs it). **Missing information:** a list of anything I didn't give you, which you marked as [FILL IN]. Rules: Use only the commands and details I provided. Never include real secrets, keys or internal URLs. Put the fastest path to a working setup first; move edge cases to Troubleshooting.