From 7f7a7e9f941df21d189a02463389d095d7bdbc47 Mon Sep 17 00:00:00 2001 From: JOJO <1498581755@qq.com> Date: Tue, 16 Dec 2025 18:35:15 +0800 Subject: [PATCH] docs: refresh README and guidelines --- AGENTS.md | 10 ++++++---- README.md | 35 +++++++++++++++++++++++------------ 2 files changed, 29 insertions(+), 16 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 16e0b60..8030c3a 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -7,6 +7,7 @@ - `utils/` provides API clients, context helpers, and logging; import from here instead of adding globals. - `prompts/`, `data/`, and `project/` bundle prompt templates, fixtures, and demos used primarily for reference. - `test/` stores integration helpers (`api_interceptor_server.py`, `test_deepseek_output.py`); add new suites alongside them. +- 前端：`static/src/components/chat/monitor` 是虚拟显示器动画层；涉及新场景请在 `MonitorDirector`/`monitor store` 内对齐数据与动画的状态同步。 ## Build, Test, and Development Commands - `pip install -r requirements.txt` installs Python dependencies. @@ -14,12 +15,13 @@ - `python web_server.py` serves the web UI at `http://localhost:8091`. - `python test/api_interceptor_server.py` starts the mock proxy that logs traffic to `api_logs/`. - `python test_deepseek_output.py` exercises streaming tool-calls; populate `config.py` with valid API credentials first. +- `npm install` then `npm run build` builds the Vue frontend to `static/dist`; `npm run dev` watches; `npm run lint` for TS/Vue linting. ## Coding Style & Naming Conventions -- Target Python 3.8+, 4-space indentation, `snake_case` functions, and `PascalCase` classes. -- Add type hints and concise docstrings that follow the existing bilingual tone. -- Use `utils.logger.setup_logger` for diagnostics; reserve `print` for intentional terminal output. -- Keep modules focused: add new features in dedicated `modules/` files with descriptive names. +- Target Python 3.11+, 4-space indentation, `snake_case` functions, and `PascalCase` classes. +- TypeScript 5 / Vue 3 单文件组件，保持 `