readme

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Update README

更新 README

Update the project README.md with comprehensive documentation.

Analyze Project Structure and State
- List the files in the root directory to identify the project type (Node.js, Python, etc.).
- Read key configuration files if they exist (e.g.,
```
package.json
```
  ,
```
tsconfig.json
```
  ,
```
shopify.app.toml
```
  ,
```
fly.toml
```
  ,
```
requirements.txt
```
  ,
```
Gemfile
```
  ,
```
cargo.toml
```
  ).
- List the contents of valid source directories (e.g.,
```
app/
```
  ,
```
src/
```
  ,
```
lib/
```
  ,
```
components/
```
  ) to understand the architecture.
Read Existing Documentation
- Read the current
```
README.md
```
  to preserve any manual sections or specific instructions the user has added.
- If available, read
```
.agent/brain/task.md
```
  or
```
implementation_plan.md
```
  to understand recent changes and current features (optional, do not fail if missing).
Generate/Update README.md
- Rewrite
```
README.md
```
  to include the following sections (adapt as necessary for the project type):
  - Project Title & Description: A clear summary of what the project does.
  - Features: A list of key features inferred from the codebase and installed packages/skills.
  - Tech Stack: Languages, frameworks, and key libraries used.
  - Prerequisites: Tools needed to run the project (Node, Python, Docker, etc.).
  - Getting Started / Installation: Step-by-step instructions to install dependencies and run the project (e.g.,
```
npm install
```
    ,
```
npm run dev
```
    ).
  - Project Structure: A high-level overview of the main directories.
  - Workflows & Skills: Mention available workflows (like this one) or skills if relevant.
  - License: If a license file exists, mention it.
Review and Verification
- Ensure the new
```
README.md
```
  is formatted correctly in Markdown.
- Check that all links (if any) are valid.

更新项目 README.md，补充全面的文档。

分析项目结构与状态
- 列出根目录下的文件，识别项目类型（Node.js、Python 等）。
- 读取存在的关键配置文件（例如
```
package.json
```
  、
```
tsconfig.json
```
  、
```
shopify.app.toml
```
  、
```
fly.toml
```
  、
```
requirements.txt
```
  、
```
Gemfile
```
  、
```
cargo.toml
```
  ）。
- 列出有效源码目录的内容（例如
```
app/
```
  、
```
src/
```
  、
```
lib/
```
  、
```
components/
```
  ），理解项目架构。
读取现有文档
- 读取当前的
```
README.md
```
  ，保留用户添加的所有手动编写的章节或特定说明。
- 如果存在的话，读取
```
.agent/brain/task.md
```
  或
```
implementation_plan.md
```
  ，了解近期变更和当前功能（可选，文件缺失时不影响执行）。
生成/更新 README.md
- 重写
```
README.md
```
  ，包含以下章节（可根据项目类型适当调整）：
  - 项目标题与描述：清晰概述项目的用途。
  - 功能特性：根据代码库和已安装的包/skill 推断出的核心功能列表。
  - 技术栈：使用的语言、框架和核心库。
  - 前置依赖：运行项目所需的工具（Node、Python、Docker 等）。
  - 快速上手/安装指南：安装依赖和运行项目的分步说明（例如
```
npm install
```
    、
```
npm run dev
```
    ）。
  - 项目结构：核心目录的高层级概览。
  - 工作流与 Skill：如果相关，提及可用的工作流（比如本流程）或 skill。
  - 许可证：如果存在许可证文件，予以说明。
审阅与验证
- 确保新的
```
README.md
```
  的 Markdown 格式正确。
- 检查所有链接（如有）有效。