更新TODO文档 + linux发行文件

api/python/README.md

@@ -39,7 +39,7 @@ from PPOCR_api import GetOcrApi
 1. 引擎部署在本地：
 - 在 [Releases](https://github.com/hiroi-sora/PaddleOCR-json/releases) 中下载OCR引擎二进制程序到本地，解压。
 - Windows 平台：`exePath` 传入 `PaddleOCR-json.exe` 的路径。
-- Linux 平台： TODO
+- Linux 平台：`exePath` 传入 `run.sh` 的路径
 2. 引擎部署在远程：
 - 在服务器上部署 PaddleOCR-json 程序，启用服务器模式，并确保客户机可以访问服务器。
 - 客户机：`exePath` 传入 `"remote://ip:port"` 。

api/python/demo1.py

@@ -12,7 +12,7 @@
 # 初始化识别器对象，传入 PaddleOCR-json 引擎路径。
 # 引擎下载地址： https://github.com/hiroi-sora/PaddleOCR-json/releases
 # Windows： 传入 PaddleOCR-json.exe 的路径。
-# Linux： TODO
+# Linux： 传入 run.sh 的路径
 ocr = GetOcrApi(r"Your Path/PaddleOCR-json.exe")
 
 if ocr.getRunningMode() == "local":

cpp/CMakeLists.txt

@@ -369,4 +369,10 @@ else ()
         PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE
         DESTINATION "."
     )
+    # 安装README.txt
+    install(
+        FILES
+            "${CMAKE_CURRENT_SOURCE_DIR}/tools/linux_dist_tools/README.txt"
+        DESTINATION "."
+    )
 endif ()

cpp/tools/linux_dist_tools/README.txt

@@ -0,0 +1,55 @@
+使用手册
+
+感谢下载使用PaddleOCR-json引擎（https://github.com/hiroi-sora/PaddleOCR-json）。
+
+你可以选择以下任意一种方式运行本引擎。
+
+# 无安装直接运行引擎
+
+只需运行 “run.sh” 脚本即可。
+
+# 安装到系统环境再运行
+
+先运行 “install_env.sh” 脚本来安装引擎到系统环境。
+
+下一步运行 “source ~/.bashrc” 来刷新系统环境。
+
+之后就可以直接使用 “PaddleOCR-json” 来运行引擎了。
+
+# 错误排查
+
+如果出现以下错误：
+
+PaddleOCR-json: error while loading shared libraries: libiomp5.so
+
+这代表着你的系统里缺少了一个运行依赖库 “libiomp5.so” ，请自行安装所需的依赖库到系统。
+
+
+
+
+Usage Manual
+
+Thanks for downloading & using PaddleOCR-json engine (https://github.com/hiroi-sora/PaddleOCR-json).
+
+You can choose any of following methods to run the engine.
+
+# No install, run engine directly
+
+You can use "run.sh" script to run it.
+
+# Install to system environment and then run engine
+
+First run "install_env.sh" script to install engine to your system environment.
+
+Next run "source ~/.bashrc" to refresh your system environment.
+
+Finally, you can use "PaddleOCR-json" to run engine.
+
+# Troubleshooting
+
+If following error occurs:
+
+PaddleOCR-json: error while loading shared libraries: libiomp5.so
+
+This indicates that your system is missing a runtime dependency library "libiomp5.so", please install all the dependency libraries to your system.
+