comate可一键生成符合开源规范的readme.md文件，支持ide右键触发、cli命令或saas api调用，并可通过.comaterc.yml定制标题、描述、徽章及章节顺序。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
你想快速生成项目标准README.md文件，又不想手动写标题、功能说明、安装步骤和使用示例——Comate能直接根据你的代码结构和git仓库信息自动生成符合开源规范的README。
用Comate一键生成README.md
打开你已初始化git的项目根目录，在VS Code或PyCharm中右键空白处→选择「Comate: Generate README」→等待3～5秒，README.md自动创建并打开。
这一步依赖项目中存在package.json、requirements.txt或pyproject.toml等元数据文件；【若项目无任何依赖声明文件，Comate将无法识别技术栈，生成内容会缺失安装与运行章节】。
生成后立即保存文件，无需额外操作。
在命令行中触发生成（适用于无IDE插件环境）
方法一：使用Comate CLI指令
确保已全局安装comate-cli（npm install -g comate-cli 或 pip install comate-cli），进入项目根目录后执行：
comate readme --format=markdown --output=README.md
方法二：调用Comate SaaS API（需登录状态）
在终端运行：
curl -X POST "https://api.comate.baidu.com/v1/readme/generate" \
-H "Authorization: Bearer $(comate auth token)" \
-d '{"repo_path":".'}" \> README.md
注意：该API调用会读取当前目录的.git/config和最近3次commit message，用于填充“项目背景”和“更新日志”区块。
定制化生成：让README更贴合团队规范
第一步：在项目根目录新建.comaterc.yml文件
第二步：写入以下内容（可按需删减字段）：
title: "AI无声译手"
description: "基于文心4.5的手语动画实时生成工具"
badges:
- "https://img.shields.io/badge/Python-3.10%2B-blue"
- "https://img.shields.io/badge/Model-ERNIE4.5-turbo-green"
sections:
- usage
- api_reference
- contribution
第三步：右键→「Comate: Generate README with config」
Comate会严格按.comaterc.yml中声明的section顺序组织内容，跳过未列出的默认区块（如“License”若未声明则不生成）。
第四步：检查生成的README中是否包含你指定的badge链接——如果显示为纯文本而非渲染后的徽章图，说明你的Markdown预览器未启用HTML支持，需在VS Code设置中开启"markdown.preview.breaks"。
