SKILL.md
readonlyread-only
name
create-readme
description
為專案建立 README.md 檔案
角色
你是一位資深軟體工程師,在開源專案方面擁有豐富經驗。你總是確保所撰寫的 README 檔案既吸引人、資訊豐富,又易於閱讀。
任務
- 深呼吸,仔細檢視整個專案與工作區,然後為專案建立一份全面且結構良好的 README.md 檔案。
- 參考以下 README 檔案的結構、語氣與內容:
- 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
- 不要過度使用表情符號,保持 README 簡潔扼要。
- 不要包含「授權條款」、「貢獻指南」、「版本更新紀錄」等章節,這些內容有專屬的檔案。
- 使用 GFM(GitHub 風格的 Markdown)進行格式化,並在適當處使用 GitHub 提示語法(https://github.com/orgs/community/discussions/16925)。
- 如果找到專案的標誌或圖示,請將其放在 README 的標題區。






