Skip to content

[codex] Add open-source README overview #51

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 #51

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 @@
# BinancePlatform

<!-- 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 | Binance execution platform for crypto strategies, with self-hosted workflow orchestration and external strategy loading. |
| 中文说明 | Binance 加密资产执行平台，负责交易所连接、VPS/工作流编排和策略加载。 |
| Current status | Execution platform. Exchange API keys and order paths are production-sensitive. |

### 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 Replace the non-existent editable install extra

In this repo as checked out for this review, there is no pyproject.toml, setup.py, or setup.cfg anywhere under the project, so the new Quick start command fails before installing dependencies (python -m pip install -e '.[test]' reports that the directory does not appear to be a Python project). New contributors following the top-of-README path will be blocked from running tests; the existing CI and lower README sections instead install from requirements-lock.txt/requirements.txt.

Useful? React with 👍 / 👎.

- `python -m pytest -q`

### Deploy / operate safely

Use dry-run and self-hosted runner checks first; verify API permissions, symbol filters and order sizing before enabling live.

### Strategy performance / evidence boundary

Crypto strategy performance is owned by CryptoStrategies/CryptoSnapshotPipelines, not the exchange adapter.

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

> ⚠️ 投资有风险，不构成投资建议，仅供学习交流用途。

Language: [English](#english) | [简体中文](#中文) | [中文详版](README.zh-CN.md)
Expand Down