SuperAPI AI 工具集

create-readme

通用与其它

查看项目

更新于 10-16 05:04

技能介绍

用途:为项目创建一份完整的 README.md。技能设定为资深开源项目工程师角色,强调 README 要有吸引力、信息充分、易于阅读。

主要能力与做法:先通读整个项目与工作区,再编写结构良好的 README;可参考同目录 references/ 下的 README 示例(按项目类型选择最接近的,不必全部阅读),示例类型包括:LangChain.js 的 Serverless AI Chat with RAG(完整 Web 应用 README:徽章头部、概览、特性、安装部署步骤、资源)、JavaScript/TypeScript 的 Serverless Recipes(示例集合 README:简介、前置条件、运行步骤、示例列表)、run-on-output(CLI 工具 README:简洁、功能列表、安装、用法示例)、smoke(开发者工具 README:简介、先给简单示例、安装、详细用法)。

格式要求:使用 GFM(GitHub Flavored Markdown),并在合适处使用 GitHub admonition 语法;如能找到项目 logo 或图标,放入 README 头部;不要过度使用 emoji,保持简洁切题;不包含 LICENSE、CONTRIBUTING、CHANGELOG 等章节,因为已有专门文件承载。

语言与个人仓库处理:默认用英文撰写;判断是否为个人仓库(远端所有者与 gh api user --jq .login 匹配;无法确认则视为外部仓库)。若为个人仓库,额外生成 README_zh-CN.md——按中文重新组织英文 README,保持相同技术事实、范围、使用步骤与关键限制,而非逐句翻译,并让两个文件互相交叉链接。

限制:资料未提供具体安装命令、收费方式、支持平台或运行环境要求;实际使用需依据技能所在平台与本地文件(如 references/ 示例)执行。