修改了readme
This commit is contained in:
@@ -49,6 +49,7 @@
|
||||
4. 根据业务特性补充状态机上下文字段与测试用例,确保状态迁移可验证。
|
||||
|
||||
可参考:
|
||||
- `docs/library_integration_guide.md`(库化安装、datasource 引用方式、backend 适配方式)
|
||||
- `sync_state_machine/datasource/README.md`
|
||||
- `docs/runtime_config_guide.md`
|
||||
- `tests/README.md`
|
||||
@@ -56,12 +57,18 @@
|
||||
## 5. 使用方法
|
||||
|
||||
### JSONL 同步
|
||||
- 基线配置(优先):`python run.py --config_path=run_profiles/preset/jsonl_to_jsonl.default.yaml`
|
||||
- 使用自定义配置:先从 `run_profiles/preset/jsonl_to_jsonl.default.yaml` 复制到 `run_profiles/jsonl_to_jsonl.local.yaml`,按需修改后运行:`python run.py --config_path=run_profiles/jsonl_to_jsonl.local.yaml`
|
||||
- 基线配置(优先):`ecm-sync-run --config_path=run_profiles/preset/jsonl_to_jsonl.default.yaml`
|
||||
- 兼容旧入口:`python run.py --config_path=run_profiles/preset/jsonl_to_jsonl.default.yaml`
|
||||
- 使用自定义配置:先从 `run_profiles/preset/jsonl_to_jsonl.default.yaml` 复制到 `run_profiles/jsonl_to_jsonl.local.yaml`,按需修改后运行:`ecm-sync-run --config_path=run_profiles/jsonl_to_jsonl.local.yaml`
|
||||
|
||||
### API 同步
|
||||
- 基线配置:`python run.py --config_path=run_profiles/preset/jsonl_to_api.default.yaml`
|
||||
- 使用自定义配置:先从 `run_profiles/preset/jsonl_to_api.default.yaml` 复制到 `run_profiles/jsonl_to_api.local.yaml`,按需修改后运行:`python run.py --config_path=run_profiles/jsonl_to_api.local.yaml`
|
||||
- 基线配置:`ecm-sync-run --config_path=run_profiles/preset/jsonl_to_api.default.yaml`
|
||||
- 兼容旧入口:`python run.py --config_path=run_profiles/preset/jsonl_to_api.default.yaml`
|
||||
- 使用自定义配置:先从 `run_profiles/preset/jsonl_to_api.default.yaml` 复制到 `run_profiles/jsonl_to_api.local.yaml`,按需修改后运行:`ecm-sync-run --config_path=run_profiles/jsonl_to_api.local.yaml`
|
||||
|
||||
### 库模式使用
|
||||
- 本地可编辑安装:`pip install -e .`
|
||||
- 接入说明:`docs/library_integration_guide.md`
|
||||
|
||||
### 配置与校验
|
||||
- 模板配置:`run_profiles/preset/*.default.yaml`
|
||||
@@ -84,6 +91,7 @@
|
||||
- 状态机规则:`docs/state_machine.md`
|
||||
- 同步流程:`docs/sync_flow.md`
|
||||
- 运行配置:`docs/runtime_config_guide.md`
|
||||
- 库化与接入:`docs/library_integration_guide.md`
|
||||
- Collection 查询与升级:`docs/collection_query_and_upgrade_plan.md`
|
||||
- 运维迭代:`docs/operations.md`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user