Skip to content

Commit

Permalink
README.md: tweak
Browse files Browse the repository at this point in the history
  • Loading branch information
Integral-Tech committed Sep 6, 2023
1 parent e28658b commit 03af216
Showing 1 changed file with 4 additions and 47 deletions.
51 changes: 4 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,5 @@
# Pot-App 文字识别插件模板仓库 (以 [OCR Space](https://ocr.space/) 为例)
# Pot-App 文字识别 Google 插件

### 此仓库为模板仓库,编写插件时可以直接由此仓库创建插件仓库

## 插件编写指南

### 1. 插件仓库创建

- 以此仓库为模板创建一个新的仓库
- 仓库名为 `pot-app-recognize-plugin-<插件名>`,例如 `pot-app-recognize-plugin-ocrspace`

### 2. 插件信息配置

编辑 `info.json` 文件,修改以下字段:

- `id`:插件唯一 id,必须以`[plugin]`开头,例如 `[plugin].com.pot-app.ocrspace`
- `display`: 插件显示名称,例如 `OCR Space`
- `homepage`: 插件主页,填写你的仓库地址即可,例如 `https://github.com/pot-app/pot-app-recognize-plugin-template`
- `icon`: 插件图标,填写当前目录下的图标名称,例如 `icon.png`
- `needs`: 插件依赖,一个数组,每个依赖为一个对象,包含以下字段:
- `key`: 依赖 key,对应该项依赖在配置文件中的名称,例如 `apikey`
- `display`: 依赖显示名称,对应用户显示的名称,例如 `API Key`
- `language`: 插件支持的语言映射,将 pot 的语言代码和插件发送请求时的语言代码一一对应

### 3. 插件编写/编译

编辑 `src/lib.rs` 实现 `recognize` 函数

```bash
cargo test --package plugin --lib -- tests --nocapture # 运行测试用例
cargo build --release # 编译
```

### 4. 打包 pot 插件

1.`target/release`目录找到`plugin.dll`(Windows)/`libplugin.dylib`(MacOS)/`libplugin.so`(Linux)文件,统一删除`lib`前缀.

2.`plugin.dll`/`libplugin.dylib`/`libplugin.so`文件和`info.json`以及图标文件压缩为 zip 文件。

3. 将文件重命名为`<插件id>.potext`,例如`[plugin].com.pot-app.ocrspace.potext`,即可得到 pot 需要的插件。

## 自动编译打包

本仓库配置了 Github Actions,可以实现推送后自动编译打包插件。

每次将仓库推送到 GitHub 之后 actions 会自动运行,将打包好的插件上传到 artifact,在 actions 页面可以下载

每次提交 Tag 之后,actions 会自动运行,将打包好的插件上传到 release,在 release 页面可以下载打包好的插件
- 需要申请 API 密钥
- API 申请教程请参考[此处](https://bobtranslate.com/service/ocr/google.html),需要自备 MasterCard / VISA 卡
- 免费额度每月 1000 次

0 comments on commit 03af216

Please sign in to comment.