Skip to content

Commit 6cdfc44

Browse files
committed
docs: add open-source README overview
1 parent 9cd3c6f commit 6cdfc44

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,36 @@
11
# LongPort US Equity Strategy Runtime
22

3+
<!-- qsl-doc-overview:start -->
4+
5+
> ⚠️ 投资有风险,不构成投资建议,仅供学习交流用途。
6+
> ⚠️ Investing involves risk. This project does not provide investment advice and is for educational and research purposes only.
7+
8+
## Open-source overview / 开源项目入口
9+
10+
| Item | Description |
11+
| --- | --- |
12+
| Project type | execution platform |
13+
| What it does | LongBridge execution platform for US/HK equity strategies across paper, HK and SG Cloud Run services. |
14+
| 中文说明 | LongBridge 执行平台,支持美股/港股策略在 paper、HK、SG 等服务形态运行。 |
15+
| Current status | Execution platform with region and broker-specific controls. |
16+
17+
### Quick start
18+
19+
- `python -m pip install -e '.[test]'`
20+
- `python -m pytest -q`
21+
22+
### Deploy / operate safely
23+
24+
Use dry-run mode and region-specific Cloud Run settings first; confirm currency, market suffixes and fractional-share behavior before live.
25+
26+
### Strategy performance / evidence boundary
27+
28+
Strategy return/drawdown evidence belongs to the strategy packages and snapshot pipelines consumed by this platform.
29+
30+
> Detailed runbooks, migration notes, workflow internals, and historical decisions are kept below. Start with this overview before using the lower-level operational sections.
31+
32+
<!-- qsl-doc-overview:end -->
33+
334
> Risk warning: this project is not investment advice and is provided for study and engineering validation only.
435
536
Language: [English](README.md) | [中文](README.zh-CN.md)

0 commit comments

Comments
 (0)