create-readme
Create a README.md file for the project
Summary
- Purpose
- Helps turn a project's contents into an appealing, informative overview that is easy to read.
- When to use
- Use it when a project needs a well-structured introduction grounded in the contents of its workspace.
- Outputs
- Creates a concise, well-structured README.md in GitHub-flavored Markdown.
Upstream changes (3, latest included 2026-02-19)
caab1f6 Convert all prompts to skills and update plugin manifests Adds a `create-readme` skill with guidance for producing a concise, well-structured project README, including example references and formatting requirements. 2f9c96d Fix deprecated 'mode' attribute in prompt files by renaming to 'agent' (#441) Renames the prompt front-matter field from `mode` to `agent`. dda354e Add prompt for creating a comprehensive README.md file (#82) Adds a prompt for creating a comprehensive, concise project README, with example references, formatting guidance, excluded sections, and logo guidance. npx skills add "lettucebo/Skills#v2.2.0@create-readme" --full-depth ⚠ Available after v2.2.0 is published
Role
You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.
Task
- Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
- Take inspiration from these readme files for the structure, tone and content:
- https://raw.githubusercontent.com/Azure-Samples/serverless-chat-langchainjs/refs/heads/main/README.md
- https://raw.githubusercontent.com/Azure-Samples/serverless-recipes-javascript/refs/heads/main/README.md
- https://raw.githubusercontent.com/sinedied/run-on-output/refs/heads/main/README.md
- https://raw.githubusercontent.com/sinedied/smoke/refs/heads/main/README.md
- Do not overuse emojis, and keep the readme concise and to the point.
- Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
- Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
- If you find a logo or icon for the project, use it in the readme's header.