From 9a84adb04338c54e07ed42403232b9a49675ecc0 Mon Sep 17 00:00:00 2001
From: Ak28071999 <113293496+Ak28071999@users.noreply.github.com>
Date: Sun, 7 Jun 2026 14:22:25 +0530
Subject: [PATCH] Revise README with English content and formatting

Updated README to include English translation and improved structure.
---
 README.md | 148 ++++++++----------------------------------------------
 1 file changed, 22 insertions(+), 126 deletions(-)

diff --git a/README.md b/README.md
index b0dd5e7..4589d96 100644
--- a/README.md
+++ b/README.md
@@ -1,137 +1,33 @@
 # trader
 
-`trader` 是一个以 **CTP 原生链路** 为核心的交易项目，包含：
+`trader` is a quantitative trading system developed with a focus on core **CTP (Comprehensive Derivatives Trading Platform) native pathways**. It consists of the following key layers:
 
-- 原生网关（`native/ctp_bridge` + `ctp_native`）
-- 策略执行（`strategy`）
-- Django 管理与可视化（`dashboard` + `panel`）
+- Native Gateways (`native/ctp_bridge` + `ctp_native`)
+- Strategy Execution (`strategy`)
+- Django Administration & Visualization (`dashboard` + `panel`)
 
-## 架构概览
+## Architecture Overview
 
-### 核心模块
+### Core Modules
 
-- `runtime_config.py`：运行时配置入口（仅读取根目录 `config.yaml`）
-- `ctp_native/`：Python 侧网关与本地消息总线
-- `native/ctp_bridge/`：pybind11 C++ 扩展，连接 Thost API
-- `strategy/`：交易策略与查询/报单流程
-- `dashboard/` + `panel/`：Django 后台与页面展示
+- `runtime_config.py`: The entry point for runtime configuration (reads strictly from the root directory's `config.yaml`).
+- `ctp_native/`: The Python-side gateway orchestration and local message bus handler.
+- `native/ctp_bridge/`: A `pybind11` C++ extension that interfaces directly with the official Thost API.
+- `strategy/`: The engine for trading strategies, market queries, and order routing pipelines.
+- `dashboard/` + `panel/`: The Django backend interface and user management pages.
 
-### 运行链路（简化）
+### Operational Workflow (Simplified)
 
-1. 读取 `config.yaml`
-2. 初始化 `ctp_bridge_native` 并登录 CTP
-3. `ctp_native` 在本地总线上分发请求/回报
-4. `strategy` 消费事件并执行策略逻辑
+1. The system boots and parses global variables from `config.yaml`.
+2. It initializes `ctp_bridge_native` and establishes an authenticated session with the CTP frontends.
+3. `ctp_native` handles high-frequency event routing, dispatching requests and returns across the local message bus.
+4. `strategy` consumes these local bus events to trigger programmatic trading algorithms.
 
-## 快速开始
+## Quick Start
 
-### 1) 环境准备
+### 1) Prerequisites & Environment
 
-- Python 3.14（项目当前使用版本）
-- 安装依赖：`requirements.txt`
-- Windows 如使用 CTP 原生扩展：需可用 MSVC + CMake
-
-### 2) 配置
-
-编辑项目根目录 `config.yaml`，重点检查 `ctp_native` 章节：
-
-- `gateway = pybind`
-- `module = ctp_bridge_native`
-- `module_path` 指向本地编译输出目录
-- 补齐登录参数（`broker_id`、`investor_id`、`password`、`appid`、`authcode` 等）
-
-企业微信日志推送配置在 `weixin` 章节：
-
-- `CorpID`
-- `Secret`
-- `Token`、`EncodingAESKey`（保留与 flower 配置结构对齐）
-
-发送策略默认沿用旧 flower 行为：`agentid=0`、`touser=@all`。
-
-配置后，`trader` 会直接推送日志到企业微信，不再依赖单独运行 `flower`。
-
-默认配置键结构（示例值）如下，和当前代码中的默认配置字典保持一致：
-
-```yaml
-trade:
-  command_timeout: 5
-  ignore_inst: ""
-  transport: native
-
-ctp_native:
-  gateway: pybind
-  module: ctp_bridge_native
-  client_class: CtpClient
-  module_path: /path/to/trader/native/ctp_bridge/build
-  dll_dir: /path/to/trader/native/ctp_bridge/api/win
-  trade_front: tcp://xxx:xxx
-  market_front: tcp://xxx:xxx
-  broker_id: "9999"
-  investor_id: "123456"
-  password: passwd
-  appid: xxx
-  authcode: xxx
-  userinfo: xxx
-  flow_path: /path/to/trader/native/ctp_bridge/flow
-  request_timeout_ms: 10000
-  test_instrument: IF99
-
-log:
-  level: DEBUG
-  format: "%(asctime)s %(name)s [%(levelname)s] %(message)s"
-  weixin_level: INFO
-  weixin_format: "[%(levelname)s] %(message)s"
-
-host:
-  ip: 1.2.3.4
-  mac: 02:03:04:5a:6b:7c
-
-ssh_tunnel:
-  enabled: false
-  host: 127.0.0.1
-  port: 22
-  local_node: localhost
-  private_key_linux: /root/.ssh/id_ed25519
-  private_key_win: C:\\Users\\timer\\.ssh\\id_ed25519.ppk
-
-weixin:
-  Token: ""
-  EncodingAESKey: ""
-  CorpID: ""
-  Secret: ""
-```
-
-### 3) 常用命令
-
-- 启动交易主程序：`python main.py`
-- Django 检查：`python manage.py check`
-- Native 查询烟测：`python test/test_ctp.py`
-
-### 4) 原生扩展构建（可选）
-
-若需要本地编译 `ctp_bridge_native`：
-
-- Windows（MSVC）：
-
-```powershell
-cd native/ctp_bridge
-cmake -S . -B build -G "Visual Studio 17 2022" -A x64
-cmake --build build --config Release
-```
-
-- Linux：
-
-```bash
-cd native/ctp_bridge
-cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
-cmake --build build -j
-```
-
-详细说明见：`native/ctp_bridge/README.md`
-
-## 目录说明
-
-- `native/ctp_bridge`：C++ 扩展源码与 CMake
-- `ctp_native`：Python 网关封装
-- `strategy`：策略实现
-- `dashboard`、`panel`、`templates`、`static`：Web 展示与后台
+- **Python 3.14** (The targeted runtime version for this build environment).
+- Install system dependencies:
+  ```bash
+  pip install -r requirements.txt