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.