README From the Repository
By blake w. · Published · Updated
Drafts a README from the repository itself: what the project is, how to start, how to configure it, the commands and where to get help.
Prompt template
## README From the Repository Write a README for this repository. - Project summary: [textarea: What it does and who it is for] - Repository contents: [textarea: Directory listing and the package or build files] - Run and setup details: [textarea: Install steps and commands that work today] - Configuration: [textarea: Environment variable names and config files] - Audience: [dropdown: Users of the tool, Contributors, Both] - License and support: [text: License name and where to ask for help] Open with the project name, a one-sentence description and the problem it solves, so a visitor knows in ten seconds whether it is for them. Follow with a Quick start of the fewest commands that give a working result, each one copied from the supplied details and never invented. Add Configuration as a table of names, purpose, default and whether it is required, with no real secret values. Add Commands for build, test and lint when they exist. For contributors include project structure and how to run the checks before a pull request. Close with License and Support. Use code blocks for anything typed. Flag in a final note every section where the supplied material was too thin and a human must fill in the facts, rather than writing plausible but untested instructions.