Skip to content

Commit 274732a

Browse files
committed
docs: add open-source README overview
1 parent b130a8a commit 274732a

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,36 @@
11
# QuantAdvisorResearch
22

3+
<!-- qsl-doc-overview:start -->
4+
5+
> ⚠️ 投资有风险,不构成投资建议,仅供学习交流用途。
6+
> ⚠️ Investing involves risk. This project does not provide investment advice and is for educational and research purposes only.
7+
8+
## Open-source overview / 开源项目入口
9+
10+
| Item | Description |
11+
| --- | --- |
12+
| Project type | research publisher |
13+
| What it does | Publishes advisory research reports from web/RSS, market confirmation and review artifacts without creating orders. |
14+
| 中文说明 | 投研报告生成与发布系统,整合新闻/RSS、市场确认和复盘,不生成订单或账户建议。 |
15+
| Current status | Research-only publisher. It must stay separate from execution systems. |
16+
17+
### Quick start
18+
19+
- `python -m pip install -e '.[test]'`
20+
- `python -m pytest -q`
21+
22+
### Deploy / operate safely
23+
24+
Use its publishing workflows after checking sources and output destination. Do not store API keys in README or artifacts.
25+
26+
### Strategy performance / evidence boundary
27+
28+
Recommendation review artifacts track absolute/relative returns for accountability; see `docs/system_design.md` and `.zh-CN.md`.
29+
30+
> Detailed runbooks, migration notes, workflow internals, and historical decisions are kept below. Start with this overview before using the lower-level operational sections.
31+
32+
<!-- qsl-doc-overview:end -->
33+
334
> ⚠️ 投资有风险,不构成投资建议,仅供学习交流用途。
435
536

0 commit comments

Comments
 (0)