Skip to content

[codex] Add open-source README overview #79

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

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

<!-- 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 | snapshot pipeline |
| What it does | Builds crypto feature snapshots and release artifacts for crypto strategy runtimes. |
| 中文说明 | 加密资产 snapshot 管线，负责生成 crypto strategy runtime 消费的上游 artifact。 |
| Current status | Research and artifact producer. Generated artifacts are not trading instructions by themselves. |

### 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 Use a quick-start install command this repo supports

In a fresh checkout this command cannot work because the repository does not include packaging metadata (pyproject.toml, setup.cfg, or setup.py; I checked the tracked files with rg --files), so pip install -e '.[test]' fails before users can run the advertised test command. For the new open-source entry point, this blocks the documented onboarding path; point users at the existing requirements.txt/venv flow or add the missing package metadata and test extra.

Useful? React with 👍 / 👎.

- `python -m pytest -q`

### Deploy / operate safely

Use GitHub Actions artifact publishing paths after dry-run validation; verify exchange symbols, quote currency and GCS targets first.

### Strategy performance / evidence boundary

Performance/backtest evidence is in README/docs and generated CSV summaries. Keep live decisions separate from one-off artifact generation.

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

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


Expand Down