From 5b78654e6e43436706bb44eedf57c02fc9d9d77d Mon Sep 17 00:00:00 2001 From: Pigbibi <20649888+Pigbibi@users.noreply.github.com> Date: Wed, 3 Jun 2026 15:41:23 +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 3d800b3..6f17bfd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,36 @@ # PoliticalEventTrackingResearch + + +> ⚠️ 投资有风险,不构成投资建议,仅供学习交流用途。 +> ⚠️ 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 | research pipeline | +| What it does | Tracks public political/policy event evidence and transforms it into auditable source items/events for research. | +| 中文说明 | 公开政治/政策事件研究管线,产出可审计 source_items/source_events,不做 AI 决策或交易执行。 | +| Current status | Research-only evidence pipeline. | + +### Quick start + +- `python -m pip install -e '.[test]'` +- `python -m pytest -q` + +### Deploy / operate safely + +Run source collection and publication workflows only after checking rate limits, source terms and output paths. + +### Strategy performance / evidence boundary + +The research plan covers post-event 1/5/20 trading-day returns and benchmark-relative analysis; see `docs/research_plan.zh-CN.md`. + +> Detailed runbooks, migration notes, workflow internals, and historical decisions are kept below. Start with this overview before using the lower-level operational sections. + + + > ⚠️ 投资有风险,不构成投资建议,仅供学习交流用途。