From 832fd4bd7b95d8c665320192f7755218c533cfa6 Mon Sep 17 00:00:00 2001 From: Pigbibi <20649888+Pigbibi@users.noreply.github.com> Date: Wed, 3 Jun 2026 15:39:53 +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 3068762..3fe24e7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,36 @@ # CryptoSnapshotPipelines + + +> ⚠️ 投资有风险，不构成投资建议，仅供学习交流用途。 +> ⚠️ 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]'` +- `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. + + + > ⚠️ 投资有风险，不构成投资建议，仅供学习交流用途。