Skip to content

[codex] Add open-source README overview #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Pigbibi merged 1 commit into from
Jun 3, 2026
Merged

[codex] Add open-source README overview #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,36 @@
# Firstrade Platform

<!-- qsl-doc-overview:start -->

> ⚠️ 投资有风险，不构成投资建议，仅供学习交流用途。
> ⚠️ 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]'`

@chatgpt-codex-connector chatgpt-codex-connector Bot Jun 3, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Fix the quick-start extra before publishing it

In a fresh checkout this command does not install pytest, because pyproject.toml defines no test extra (pytest only appears in requirements.txt). Pip will install the package without those test dependencies, so the next documented step, python -m pytest -q, can fail for users following the README exactly unless pytest already happens to be installed.

Useful? React with 👍 / 👎.

- `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.

<!-- qsl-doc-overview:end -->

> 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)
Expand Down