Skip to content

Commit 0dc4b25

Browse files
committed
docs(skills): complete readme setup steps
1 parent 4a5402b commit 0dc4b25

File tree

2 files changed

+24
-8
lines changed

2 files changed

+24
-8
lines changed

skills/README.ch.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,15 @@
2525

2626
## 快速开始
2727

28+
下面的示例覆盖两个 skill;只需执行你实际使用的那个 skill 对应命令。
29+
2830
1. 安装对应 skill 的依赖。
31+
```bash
32+
python -m pip install -r paddleocr-text-recognition/scripts/requirements.txt
33+
python -m pip install -r paddleocr-doc-parsing/scripts/requirements.txt
34+
# 第三行可选,仅在使用文档文件优化时需要
35+
python -m pip install -r paddleocr-doc-parsing/scripts/requirements-optimize.txt
36+
```
2937
2. 使用以下任一方式配置 API 凭证。
3038

3139
方式 A:运行要测试的 skill 对应的辅助脚本。
@@ -65,22 +73,22 @@ URL 示例:
6573

6674
### paddleocr-doc-parsing
6775

68-
URL 示例:
76+
解析 URL 示例:
6977
```text
7078
解析这个 PDF,并返回主体内容和全部表格(结构化输出):https://example.com/report.pdf
7179
```
7280

73-
本地文件示例
81+
解析本地文件示例
7482
```text
7583
解析本地文件 C:\docs\report.pdf,并返回完整结构化结果。
7684
```
7785

7886
## 验证与排错
7987

80-
- 缺依赖报错:重新执行对应的 `python -m pip install -r ...` 命令
88+
- 缺依赖报错:重新执行对应 requirements 文件的安装命令,例如 `paddleocr-text-recognition/scripts/requirements.txt``paddleocr-doc-parsing/scripts/requirements.txt`,以及文档文件优化需要时的 `paddleocr-doc-parsing/scripts/requirements-optimize.txt`
8189
- 配置问题:优先检查宿主应用或当前运行环境中是否已正确设置所需环境变量。
8290
- 对于仓库内的冒烟测试,可以重跑对应的 `configure.py`,或更新本地 `.env` 文件。
83-
- API 地址与 token 获取入口<https://www.paddleocr.com>
91+
- 如果使用 PaddleOCR 官方 API,可参考<https://www.paddleocr.com>
8492

8593
## 文档入口
8694

@@ -89,7 +97,7 @@ URL 示例:
8997

9098
## API 获取
9199

92-
请在 PaddleOCR 官网获取 API 信息<https://www.paddleocr.com>
100+
如果使用 PaddleOCR 官方 API,可参考<https://www.paddleocr.com>
93101

94102
## 许可证
95103

skills/README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,15 @@ This directory contains AI agent skills for PaddleOCR official APIs.
2525

2626
## Quick Start
2727

28+
The examples below cover both skills. Run only the commands for the skill you need.
29+
2830
1. Install dependencies for the skill you use.
31+
```bash
32+
python -m pip install -r paddleocr-text-recognition/scripts/requirements.txt
33+
python -m pip install -r paddleocr-doc-parsing/scripts/requirements.txt
34+
# Optional: required only when using document file optimization
35+
python -m pip install -r paddleocr-doc-parsing/scripts/requirements-optimize.txt
36+
```
2937
2. Configure API credentials using one of the following options.
3038

3139
Option A: run the helper script for the skill you want to test.
@@ -77,10 +85,10 @@ Parse local file C:\docs\report.pdf and return complete structured output.
7785

7886
## Verification & Troubleshooting
7987

80-
- Missing dependencies: rerun the corresponding `python -m pip install -r ...` command.
88+
- Missing dependencies: rerun the dependency installation command for the relevant file, such as `paddleocr-text-recognition/scripts/requirements.txt`, `paddleocr-doc-parsing/scripts/requirements.txt`, or `paddleocr-doc-parsing/scripts/requirements-optimize.txt`.
8189
- Configuration issues: first check whether the required environment variables are available in the host application or runtime environment.
8290
- For repository-local smoke tests, you can rerun the corresponding `configure.py` script or update the local `.env` file.
83-
- API URL and access token source: <https://www.paddleocr.com>
91+
- For direct PaddleOCR API access, see: <https://www.paddleocr.com>
8492

8593
## Documentation
8694

@@ -89,7 +97,7 @@ Parse local file C:\docs\report.pdf and return complete structured output.
8997

9098
## API Access
9199

92-
Get API credentials from the PaddleOCR official website: <https://www.paddleocr.com>
100+
For direct PaddleOCR API access, see: <https://www.paddleocr.com>
93101

94102
## License
95103

0 commit comments

Comments
 (0)