86 lines
2.2 KiB
Markdown
86 lines
2.2 KiB
Markdown
---
|
|
name: readme
|
|
description: 为当前项目生成适配 Gitee / 公司内部代码仓库的中英文双语 README。默认生成 README.md（中文，Gitee 默认展示）和 README_en.md（英文）两个文件，顶部互相链接切换语言。适用于公司项目、算法项目、机器人项目、工程代码仓库。当用户说“写个README”“生成项目介绍”“生成Gitee README”“make a readme”时使用。
|
|
---
|
|
|
|
# Gitee 双语 README 生成
|
|
|
|
为当前项目生成两个互相链接的 README 文件：
|
|
|
|
- `README.md`：简体中文，作为 Gitee 默认展示文件
|
|
- `README_en.md`：英文版，供中英文切换使用
|
|
|
|
如果项目中已经存在 `README_zh.md`、`Readme_zh.md`、`Readme_en.md` 等命名，先读取已有文件，并尽量沿用当前仓库已有命名规范；如果没有明确规范，默认使用 `README.md` + `README_en.md`。
|
|
|
|
## 执行目标
|
|
|
|
生成符合公司内部 Gitee 仓库风格的 README，不写成 GitHub 开源宣传页。
|
|
|
|
README 应该让新同事或项目参与者快速知道：
|
|
|
|
- 项目是什么
|
|
- 面向什么设备 / 平台 / 场景
|
|
- 软件架构大概是什么
|
|
- 如何安装依赖
|
|
- 如何编译 / 运行 / 启动
|
|
- 代码目录怎么组织
|
|
- 如何按公司流程参与开发
|
|
|
|
## 执行步骤
|
|
|
|
### 1. 调研项目
|
|
|
|
先充分了解项目，不要凭空编造内容。
|
|
|
|
必须优先读取和分析：
|
|
|
|
- 项目根目录结构
|
|
- 已有 README / 文档
|
|
- 主入口脚本
|
|
- 启动脚本
|
|
- `CMakeLists.txt`
|
|
- `package.xml`
|
|
- `requirements.txt`
|
|
- `pyproject.toml`
|
|
- `package.json`
|
|
- `docker-compose.yml`
|
|
- `Dockerfile`
|
|
- 配置文件
|
|
- 核心源码目录
|
|
|
|
需要识别：
|
|
|
|
- 项目名称
|
|
- 项目用途
|
|
- 运行平台
|
|
- 技术栈
|
|
- 编程语言
|
|
- 构建方式
|
|
- 启动方式
|
|
- 主要模块
|
|
- 依赖项
|
|
|
|
**重要：只写代码和文档中真实存在的内容。**
|
|
|
|
不要编造：
|
|
|
|
- 未确认的算法
|
|
- 未确认的性能指标
|
|
- 未确认的硬件型号
|
|
- 未确认的启动命令
|
|
- 未确认的部署流程
|
|
- 未确认的许可证
|
|
|
|
如果信息不足，用“待补充”明确标注，不要用通用模板假装完整。
|
|
|
|
---
|
|
|
|
## 2. 文件命名与语言切换
|
|
|
|
### 默认文件
|
|
|
|
生成：
|
|
|
|
```text
|
|
README.md
|
|
README_en.md |