{"name":"write-readme-prompt","description":"A prompt that writes a clear README.md for a project from its code - what it does, a quick start that actually runs, configuration, usage examples and where to get help - in plain GitHub Markdown without emoji clutter or invented features. Use when a repo has no README, the README is out of date, or before making a project public.","category":"coding-prompts","tags":["docs","github","writing"],"models":["any"],"proven":false,"passing_families":0,"model_testing":"Not yet model-tested; testing Jan 2027","url":"https://theskillvault.ai/skills/write-readme-prompt","api_url":"https://theskillvault.ai/api/skills/write-readme-prompt","raw_url":"https://theskillvault.ai/api/skills/write-readme-prompt/raw","body":"# Write a README (prompt)\n\nA README answers three questions fast: what is this, how do I run it, and where do I go next. This prompt writes one from your actual code.\n\n## When to use\n- Your repo has no README or a one-line one.\n- The setup steps in the README no longer work.\n- You are about to share or open-source a project.\n\n## Steps\n1. Open the project in your AI tool so it can read the code and config.\n2. Paste the prompt below.\n3. Run the quick start yourself on a clean checkout and fix anything that fails.\n4. Commit the README.\n\n## Prompt\n```text\nWrite a README.md for this project based on its actual code and config files.\n\nSections, in order:\n1. Project name and a one-sentence description of what it does and who it is for.\n2. Quick start: the exact commands to install and run it, from a fresh clone. Include required versions (Node, Python and so on).\n3. Configuration: every environment variable, with a fake example value. Point to .env.example if it exists.\n4. Usage: one or two short, real examples.\n5. Project structure: a short tree of the main folders, only if it helps.\n6. Scripts: the main commands (test, build, lint) and what each does.\n7. Help: where to report issues or ask questions.\n\nRules:\n- Only describe features that exist in the code. If unsure, leave it out or ask.\n- Plain GitHub Markdown, short sentences, no emoji decoration.\n- Do not add licence, contributing or changelog sections; those have their own files. A one-line licence pointer is fine.\n- Never include real keys, tokens or internal URLs.\n```\n\n## How to adapt\n- Library rather than app? Swap the quick start for an install and import example.\n- Internal tool? Add a \"Who owns this\" line in section 7.\n\n## Gotchas\n- Check that every command in the quick start runs. A broken first command loses most readers.\n- AI tools invent badges and features. Delete anything you cannot point to in the code.\n\n## Portability\nWorks with any language, any git host and any chat AI or coding agent. No tool lock-in.\n\n## Done when\n- A new person can clone and run the project using only the README.\n- Every listed feature and variable exists in the code, and no secrets appear.\n\n## Example prompt\n\"Write a README for this repo based on the code. Make sure the quick start commands actually work.\"\n\n---\nAdapted from \"create-readme\" in github/awesome-copilot (MIT, Copyright GitHub, Inc.). See LICENSE.txt.","files":["LICENSE.txt"],"license":"MIT","license_name":"MIT License","license_url":"https://opensource.org/license/mit","attribution":"Based on work by GitHub awesome-copilot contributors (create-readme) (Copyright GitHub, Inc., MIT License), https://github.com/github/awesome-copilot/tree/5269f7ea2d6c3a9bfda5ed878b6726cf509121fd/skills/create-readme; adapted by TheSkillVault, https://theskillvault.ai","install":{"claude_code":"curl -fsSL --create-dirs 'https://theskillvault.ai/api/skills/write-readme-prompt/raw' -o ~/'.claude/skills/write-readme-prompt/SKILL.md' && curl -fsSL --create-dirs 'https://theskillvault.ai/api/skills/write-readme-prompt/files/LICENSE.txt' -o ~/'.claude/skills/write-readme-prompt/LICENSE.txt'","cursor":"curl -fsSL --create-dirs 'https://theskillvault.ai/api/skills/write-readme-prompt/raw' -o '.cursor/skills/write-readme-prompt/SKILL.md' && curl -fsSL --create-dirs 'https://theskillvault.ai/api/skills/write-readme-prompt/files/LICENSE.txt' -o '.cursor/skills/write-readme-prompt/LICENSE.txt'","agents":"curl -fsSL --create-dirs 'https://theskillvault.ai/api/skills/write-readme-prompt/raw' -o '.agents/skills/write-readme-prompt/SKILL.md' && curl -fsSL --create-dirs 'https://theskillvault.ai/api/skills/write-readme-prompt/files/LICENSE.txt' -o '.agents/skills/write-readme-prompt/LICENSE.txt'","mcp_url":"https://theskillvault.ai/mcp","cursor_mcp_deeplink":"cursor://anysphere.cursor-deeplink/mcp/install?name=theskillvault&config=eyJ1cmwiOiJodHRwczovL3RoZXNraWxsdmF1bHQuYWkvbWNwIn0%3D","mcp_config":{"mcpServers":{"theskillvault":{"url":"https://theskillvault.ai/mcp"}}}},"bundles":[],"tested_on":[{"family":"chatgpt","name":"ChatGPT","outcome":null,"date":null,"source":null,"counts":false,"stale":false},{"family":"claude","name":"Claude","outcome":null,"date":null,"source":null,"counts":false,"stale":false},{"family":"gemini","name":"Gemini","outcome":null,"date":null,"source":null,"counts":false,"stale":false},{"family":"grok","name":"Grok","outcome":null,"date":null,"source":null,"counts":false,"stale":false},{"family":"llama","name":"Llama","outcome":null,"date":null,"source":null,"counts":false,"stale":false},{"family":"deepseek","name":"DeepSeek","outcome":null,"date":null,"source":null,"counts":false,"stale":false},{"family":"mistral","name":"Mistral","outcome":null,"date":null,"source":null,"counts":false,"stale":false},{"family":"qwen","name":"Qwen","outcome":null,"date":null,"source":null,"counts":false,"stale":false},{"family":"kimi","name":"Kimi K","outcome":null,"date":null,"source":null,"counts":false,"stale":false}],"proven_rule":{"threshold":5,"window_days":365,"computed_at":"2026-11-02T03:20:33.817Z"}}