Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hiroi-sora committed Mar 29, 2024
1 parent 089d174 commit a7ad350
Show file tree
Hide file tree
Showing 4 changed files with 375 additions and 873 deletions.
70 changes: 47 additions & 23 deletions docs/README_CLI.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,50 +29,66 @@

粘贴图片:`Umi-OCR.exe --clipboard`

指定地址`Umi-OCR.exe --path "D:/xxx.png"`
指定路径`Umi-OCR.exe --path "D:/xxx.png"`

OCR指令均可在控制台回传识别结果。请耐心等待,在一次指令结束前不要输入下一条指令。
- 可传入文件夹的路径。将搜索文件夹中所有图片(包括嵌套子文件夹),并输出所有识别结果。
- 可传入多个路径。请用双引号`""`包裹单个路径,不同路径间用空格 ` ` 隔开。

OCR指令的参数(如识别语言,是否复制到剪贴板)等同于`截图OCR`标签页。请在该标签页中修改参数。
指定多个路径示例:`Umi-OCR.exe --path "D:/img1.png" "D:/img2.png" "D:/image/test"`

#### 指令简写
注意:

所有指令支持用前几个字母替代,如`--screenshot``--clipboard`可以分别简写为`--sc``--cl`。具体可自己尝试。
- 注意:多图识别时,耗时较长;一次命令结束前不要输入下一个命令。
- 对于截屏、粘贴、路径指令,OCR参数(如识别语言,是否复制到剪贴板、是否弹出主窗口)采用`截图OCR`标签页的设定。如果不希望命令行任务弹出主窗口,请在`截图OCR`标签页中关闭该选项。

#### 二维码指令

识别二维码:`Umi-OCR.exe --qrcode_read "D:/xxx.png"`

- 与OCR指令一致,二维码识别的指令也支持传入多个图片&文件夹路径。

生成二维码:`Umi-OCR.exe --qrcode_create "文本内容" "D:/输出图片.jpeg"`

- 默认的图片宽高为最小适配长度。也可以在指令后方加上数字,手动指定图片宽高:

例,同时指定宽高为128像素:`Umi-OCR.exe --qrcode_create "文本内容" "D:/输出图片.jpeg" 128`

例,宽128,高256像素:`Umi-OCR.exe --qrcode_create "文本内容" "D:/输出图片.jpeg" 128 256`

#### 关于指令简写

- 所有指令支持用前几个字母替代,如`--screenshot``--clipboard`可以分别简写为`--sc``--cl`。具体可自己尝试。
- 对于大部分系统,支持使用小写文件名+省略`.exe`,例: `umi-ocr --sc`

---

### 结果输出

#### 将结果输出到文件:
- **复制到剪贴板** ` --clip`
- **输出到文件(覆盖)** ` --output "文件路径.txt"`
- **输出到文件(追加)** ` --output_append "文件路径.txt"`

也可以使用箭头符号:

- **覆盖原文件** ` --> 文件路径`
- **追加到文件末尾** ` -->> 文件路径`
- `"-->"` 等价于 `--output`
- `"-->>"` 等价于 `--output_append`

例:
```
./Umi-OCR.exe --screenshot --> test.txt
或加上双引号:
./Umi-OCR.exe --screenshot --clip
./Umi-OCR.exe --screenshot --output test.txt
./Umi-OCR.exe --screenshot "-->" test.txt
```

> 注1:由于运行环境的一些限制,无法使用系统管道重定向符`>`。请使用`-->`代替。
> 注2:如果该指令失效,请使用双引号括起指令:`"-->"`
#### 将结果复制到剪贴板
- ` | clip`

例:
```
./Umi-OCR.exe --screenshot | clip
```
> 注:由于运行环境的一些限制,Umi-OCR 暂时无法配合使用系统管道重定向符`>`、管道操作符`|`
---

### 高级指令

(仅供有经验的开发者使用)

高级指令代表了一种无限的可能性(笑),允许通过命令行调用每一个标签页(模块)上的每一个函数。但是用法比较复杂,你需要在一定程度上阅读本项目源码才能知道该调用哪个函数。
高级指令代表了一种无限的可能性(笑),允许通过命令行调用任意标签页(模块)上的任意函数。但是用法比较复杂,你需要在一定程度上阅读本项目源码才能知道该调用哪个函数、传入什么参数

#### 页面指令

Expand Down Expand Up @@ -118,8 +134,10 @@ Umi-OCR.exe --call_py [name]
Umi-OCR.exe --call_qml [name]
```

[name] 为模块名,[function] 为函数名, [..paras] 为任意个参数(只支持字符串类型)。
调用py模块上的函数:

- [name] 为模块名,[function] 为函数名。 [..paras] 为任意个参数。
- paras 输入字符串。会根据文本结构,自动转为4种变量类型: `int``float``list``dict`
```
Umi-OCR.exe --call_py [name] --func [function] [..paras]
```
Expand All @@ -129,9 +147,15 @@ Umi-OCR.exe --call_py [name] --func [function] [..paras]
Umi-OCR.exe --call_qml [name] --func [function] [..paras]
```

示例,调用二维码页qml模块的路径扫码函数,传入路径列表:

```
umi-ocr --call_qml QRCode --func scanPaths '[\"D:/Pictures/Screenshots/test/二维码/1111.png\",\"D:/Pictures/Screenshots/test/二维码/2222.png\"]'
```

#### 同步调用函数

> 命令行解析器运行在子线程。为了确保线程安全,会发送到主线程执行命令。所以对于你来说就是异步执行的了,即无法取得函数的返回值。
> 命令行解析器运行在子线程。为了确保线程安全,默认转到主线程执行命令。所以对于你来说就是异步执行的了,即无法取得函数的返回值。
> 如果要获取函数返回值,可传入 --thread 指令,同步执行命令。
> 这种操作较不安全,可能导致功能不正常甚至程序崩溃。
Expand Down
164 changes: 0 additions & 164 deletions docs/README_CLI_2.1.1.md

This file was deleted.

Loading

0 comments on commit a7ad350

Please sign in to comment.