Skip to content

Commit d314fcf

Browse files
committed
docs: add open-source README overview
1 parent cec8bae commit d314fcf

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
# QuantRuntimeSettings
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 | runtime settings |
13+
| What it does | Runtime settings schema and tooling for QuantStrategyLab deployments. |
14+
| 中文说明 | 运行时配置 schema 与工具,帮助各部署统一账户、profile、dry-run/live 参数。 |
15+
| Current status | Configuration tooling. It should not contain secrets or live account identifiers. |
16+
17+
### Quick start
18+
19+
- `python -m pip install -e '.[test]'`
20+
- `python -m pytest -q`
21+
22+
### Deploy / operate safely
23+
24+
Consume generated settings from platform repositories; validate redaction and environment-specific overrides before use.
25+
26+
### Strategy performance / evidence boundary
27+
28+
Not a strategy repository; correctness is schema/test coverage and safe downstream consumption.
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
[English](#english) | [中文](#中文)

0 commit comments

Comments
 (0)