From 77d0b989a92826cd32fd2d49b1e9abeb9e7148aa Mon Sep 17 00:00:00 2001
From: Pigbibi <20649888+Pigbibi@users.noreply.github.com>
Date: Sun, 10 May 2026 22:17:40 +0800
Subject: [PATCH] Add bilingual README content

---
 README.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 70 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 96d6ae5..afc947a 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,12 @@
 # QuantRuntimeSettings
 
+[English](#english) | [中文](#中文)
+
+---
+
+<a id="english"></a>
+## English
+
 Declarative runtime settings tooling for QuantStrategyLab deployments.
 
 This repository provides the schema and tooling for "which platform runs which strategy". It does not contain live runtime assignments, strategy logic, broker execution code, credentials, or secrets.
@@ -8,7 +15,7 @@ This repository provides the schema and tooling for "which platform runs which s
 
 Live target files must not be committed to this public repository. Keep real deployment choices in GitHub Variables/Environments, GitHub Secrets, Secret Manager, or ignored local files under `local/`.
 
-Use repository or environment variables for non-secret runtime choices such as `RUNTIME_TARGET_JSON` and plugin mount declarations. Use secrets only for credentials, tokens, and private keys.
+Use repository or environment variables for non-secret runtime choices such as `TARGET_SPEC_JSON`, `RUNTIME_TARGET_JSON`, and plugin mount declarations. Use secrets only for credentials, tokens, and private keys.
 
 If a deployment needs private validation policy, keep it in ignored local files such as `local/policy.json`.
 
@@ -56,3 +63,65 @@ This repo acts as a small bridge between strategy selection and platform deploym
 - Optional ignored local policy can add private strategy/plugin requirements.
 - The renderer converts the declaration into platform-specific GitHub variables.
 - Platform repositories keep their existing adapter code and consume the generated variables.
+
+---
+
+<a id="中文"></a>
+## 中文
+
+QuantStrategyLab 部署运行设置的声明式 schema 和工具仓库。
+
+这个仓库用于描述和校验“哪个平台运行哪个策略”的配置格式，但不保存真实线上运行分配、策略逻辑、券商执行代码、凭据或密钥。
+
+## 公开仓库策略
+
+真实 target 文件不能提交到这个公开仓库。真实部署选择应保存在 GitHub Variables / Environments、GitHub Secrets、Secret Manager，或放在被忽略的 `local/` 目录下。
+
+非敏感运行选择，例如 `TARGET_SPEC_JSON`、`RUNTIME_TARGET_JSON` 和插件挂载声明，可以放在 repository 或 environment variables 中。凭据、token、private key 等必须使用 secrets。
+
+如果某个部署需要私有校验策略，请放在被忽略的本地文件里，例如 `local/policy.json`。
+
+## 边界
+
+- `UsEquityStrategies` 负责分配逻辑、策略默认值和风险规则。
+- 平台仓库负责券商 adapter、运行时输入采集、通知和执行。
+- 本仓库负责运行 target 的 schema、示例、校验和渲染工具。
+- 本仓库不保存 secret value；需要时只引用 secret name 或平台仓库自身的 secret。
+
+## 命令
+
+校验示例；如果存在 `local/targets/**/*.json`，则优先校验本地 target：
+
+```bash
+python3 scripts/runtime_settings.py validate
+```
+
+渲染一个示例 target：
+
+```bash
+python3 scripts/runtime_settings.py render examples/targets/schwab/live.example.json
+```
+
+预览被忽略本地 target 对应的 GitHub variable 更新：
+
+```bash
+python3 scripts/runtime_settings.py apply local/targets/longbridge/sg.json
+```
+
+实际应用 GitHub variable 更新：
+
+```bash
+python3 scripts/runtime_settings.py apply --yes local/targets/longbridge/sg.json
+```
+
+`RUNTIME_TARGET_JSON` 是唯一 canonical source。兼容变量，例如 `STRATEGY_PROFILE`，由它生成，避免多个配置源互相漂移。
+
+## 架构
+
+这个仓库在策略选择和平台部署之间提供一个轻量 bridge，同时避免公开真实运行分配：
+
+- target 文件声明期望的运行目标。
+- validator 检查必填运行字段和插件挂载是否一致。
+- 可选的 ignored local policy 可以添加私有策略/插件要求。
+- renderer 把声明转换成平台专属 GitHub variables。
+- 平台仓库保持现有 adapter 代码，并消费生成后的变量。