From c63c02cb097b3141db04c0b375ffda873904c7d8 Mon Sep 17 00:00:00 2001 From: Pigbibi <20649888+Pigbibi@users.noreply.github.com> Date: Wed, 3 Jun 2026 15:40:14 +0800 Subject: [PATCH] docs: add open-source README overview --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 3c1f138..3ecfbe4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,36 @@ # Firstrade Platform + + +> ⚠️ 投资有风险，不构成投资建议，仅供学习交流用途。 +> ⚠️ Investing involves risk. This project does not provide investment advice and is for educational and research purposes only. + +## Open-source overview / 开源项目入口 + +| Item | Description | +| --- | --- | +| Project type | execution platform | +| What it does | Experimental Firstrade runtime for shared QuantStrategyLab US equity strategies. | +| 中文说明 | Firstrade 实验性美股执行平台，用于验证共享美股策略在该券商上的运行适配。 | +| Current status | Experimental execution platform. Prefer paper/dry-run until broker behavior is verified. | + +### Quick start + +- `python -m pip install -e '.[test]'` +- `python -m pytest -q` + +### Deploy / operate safely + +Keep live disabled until dry-run, order sizing and broker constraints are reviewed for the target account. + +### Strategy performance / evidence boundary + +Strategy performance evidence comes from UsEquityStrategies/UsEquitySnapshotPipelines. + +> Detailed runbooks, migration notes, workflow internals, and historical decisions are kept below. Start with this overview before using the lower-level operational sections. + + + > Risk warning: this project is not investment advice and is provided for study and engineering validation only. Language: [English](README.md) | [中文](README.zh-CN.md)