使用方法
- 复制安装命令,在自己的智能体环境安装前先检查源码包。
- 从原始文档核对所需工具、凭据和支持的宿主。
- 说明输入材料与期望交付物,并对照来源检查输出。
npx skills add https://github.com/hu3rror/my-skills --skill create-readme开始前需了解
- 安装不包含模型订阅、API 额度或访问文件的权限。
- 仓库星数和安装量反映活跃情况,不等于独立质量或安全测试。
按源仓库内容呈现,保留标题、案例、代码、表格、链接以及原文引用的演示图片。
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 examples (local copies in
references/alongside this skill — read the ones closest to the project's type, not all of them) for the structure, tone and content:
- Serverless AI Chat with RAG using LangChain.js — full web-app README: badge header, overview, features, setup & deployment steps, resources
- Serverless Recipes for JavaScript/TypeScript — sample collection README: intro, prerequisites, run steps, samples list
- run-on-output — CLI tool README: concise, feature list, install, usage with examples
- smoke — developer tool README: intro, easy example first, install, detailed usage
- 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.
- Write the README in English by default. Determine whether this is a personal repository (its remote owner matches
gh api user --jq .login; treat it as external if it can't be confirmed). If personal, also write aREADME_zh-CN.md: a Chinese re-organization of the English README — same technical facts, scope, usage steps, and key limitations, not a sentence-by-sentence translation — and cross-link the two files.