添加说明

main.py

@@ -26,7 +26,7 @@ def get_command_argv_by_sys():
 
 def read_data(filepath):
     content = []
-    if datafile != "":
+    if filepath != "":
         try:
             with open(filepath, "r", encoding="utf-8") as file:
                 content = json.load(file)
@@ -69,11 +69,15 @@ def replace(template_path, filename_path, data_json):
     return 0
 
 
-if __name__ == '__main__':
+def main():
     params = get_command_argv_by_sys()
     [template, filename, datafile] = params
     data = read_data(datafile)
     if len(data) == 0:
-        print(1)
+        return 1
     else:
-        print(replace(template, filename, data))
+        return replace(template, filename, data)
+
+
+if __name__ == '__main__':
+    print(main())

readme.md

@@ -2,17 +2,42 @@
 
 ## 打包
 
-### windows上直接使用以下命令打包为exe后缀的可执行文件
+1. 打包
+   > ```powershell
+   > pyinstaller -F main.py -n doc_generate.exe
+   > ```
+1. 使用
+   > 在 dist目录下找到可执行文件, 使用命令行调用
+   > ```python
+   > ./doc_generate.exe [模板文件] [生成文件] [数据文件]
+   > ```
+1. 使用示例
+    - Qt
+      > ```c++
+      >    QString templatefile = "template/template.docx"; // 模板文件
+      >    QString generatefile = "Test.docx";              // 生成文件
+      >    QString datafile = "data/data.json";             // 数据文件
+      >    QString cmd = QString("doc_generate %1 %2 %3").arg(templatefile, generatefile, datafile);
+      >    QProcess process;
+      >    process.start(cmd);
+      >    process.waitForFinished();
+      >    QString output = process.readAllStandardOutput();
+      >    qDebug() << output;
+      > ```
+
+## 注意
+
+1. 模板文件 使用相对位置，即相对**doc_generate**可执行文件的位置
+1. 生成文件 生成的文件都在**doc_generate**所在位置
+1. 数据文件 使用相对位置，即相对**doc_generate**可执行文件的位置
+2. 数据文件中若有图片路径，则图片路径也应是相对位置，即图片相对**doc_generate**可执行文件的位置
+
+## 返回值说明
+
+| 值 |   说明    |
+|:-:|:-------:|
+| 0 |   正常    | 
+| 1 | 数据内容不正确 |
+| 2 | 模板文件不正确 |
 
-```powershell
-pyinstaller -F main.py -w -n doc_generate.exe
-```
-
-## 使用
-
-使用命令行调用
-
-```powershell
-
-```