create-readme
Create a README.md file for the project
摘要
- 用途
- 协助将项目内容整理成吸引人、信息丰富且易于阅读的介绍。
- 使用时机
- 当项目需要根据工作区内容撰写架构完善的介绍时使用。
- 输出结果
- 产出以 GitHub Flavored Markdown 撰写的精简且架构完善的 README.md。
上游变更（3 条，最新收录 2026-02-19）
caab1f6 Convert all prompts to skills and update plugin manifests 添加 `create-readme` 技能，提供撰写精简、结构完善的项目 README 指引，包括范例参考与格式要求。 2f9c96d Fix deprecated 'mode' attribute in prompt files by renaming to 'agent' (#441) 将提示词前置中继数据字段从 `mode` 更名为 `agent`。 dda354e Add prompt for creating a comprehensive README.md file (#82) 添加创建完整且精简项目 README 的提示词，并提供范例参考、格式指引、应排除的章节及标志使用指引。 npx skills add "lettucebo/Skills#v2.2.0@create-readme" --full-depth ⚠ v2.2.0 发布后即可使用
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.