Skip to content

Commit 62759e4

Browse files
committed
Doc: modify compile documents
1 parent fdd5ad8 commit 62759e4

5 files changed

Lines changed: 108 additions & 2 deletions

File tree

docs/Compile/Linux.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -911,4 +911,28 @@ After install sdk and runtime, Run again:
911911
./Script/build_appimage.sh
912912
913913
- [create_plugin.sh]: Generate plugin from template
914+
915+
```
916+
k@k:/home/RabbitRemoteControl$ ./Script/create_plugin.sh -h
917+
918+
create_plugin.sh - Generate plugin from template
919+
920+
Usage: ./Script/create_plugin.sh [OPTION] PluginName
921+
922+
Options:
923+
-h, --help Show this help message
924+
-v, --verbose[=LEVEL] Set verbose mode. [LEVEL: ON, OFF]
925+
926+
Directory options:
927+
-i, --install=DIR Set installation directory
928+
929+
Other options:
930+
-n, --name=NAME Plugin name
931+
-t, --template=NAME Template name. [NAME: Base(Default), Desktop, Server, QtEvent]
932+
933+
Examples:
934+
./Script/create_plugin.sh --name=Test --template=Base
935+
./Script/create_plugin.sh -n Test -t Base
936+
```
937+
914938
- [deploy.sh](../../deploy.sh): Deploy. Only used by administarotr

docs/Compile/Linux_zh_CN.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1093,4 +1093,28 @@ CMake 使用参数 -DENABLE_UPDATE_TRANSLATIONS=ON 会自行产生资源文件
10931093
./Script/build_appimage.sh
10941094
10951095
- [create_plugin.sh]: 从模板产生插件。
1096+
1097+
```
1098+
k@k:/home/RabbitRemoteControl$ ./Script/create_plugin.sh -h
1099+
1100+
create_plugin.sh - Generate plugin from template
1101+
1102+
Usage: ./Script/create_plugin.sh [OPTION] PluginName
1103+
1104+
Options:
1105+
-h, --help Show this help message
1106+
-v, --verbose[=LEVEL] Set verbose mode. [LEVEL: ON, OFF]
1107+
1108+
Directory options:
1109+
-i, --install=DIR Set installation directory
1110+
1111+
Other options:
1112+
-n, --name=NAME Plugin name
1113+
-t, --template=NAME Template name. [NAME: Base(Default), Desktop, Server, QtEvent]
1114+
1115+
Examples:
1116+
./Script/create_plugin.sh --name=Test --template=Base
1117+
./Script/create_plugin.sh -n Test -t Base
1118+
```
1119+
10961120
- [deploy.sh](../../deploy.sh): 分发版本。仅由管理员使用。

docs/Compile/Windows.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -428,4 +428,33 @@ See: [Compile integration](../../.github/workflows/msvc.yml)
428428

429429
CMake uses the parameter -DENABLE_UPDATE_TRANSLATIONS=ON
430430
to automatically generate resource files and update the resource files.
431-
After updating, you can directly modify the .ts files.
431+
After updating, you can directly modify the .ts files.
432+
433+
### Script
434+
435+
- [create_plugin.sh]: Generate plugin from template
436+
437+
```
438+
k@k:/home/RabbitRemoteControl$ ./Script/create_plugin.sh -h
439+
440+
create_plugin.sh - Generate plugin from template
441+
442+
Usage: ./Script/create_plugin.sh [OPTION] PluginName
443+
444+
Options:
445+
-h, --help Show this help message
446+
-v, --verbose[=LEVEL] Set verbose mode. [LEVEL: ON, OFF]
447+
448+
Directory options:
449+
-i, --install=DIR Set installation directory
450+
451+
Other options:
452+
-n, --name=NAME Plugin name
453+
-t, --template=NAME Template name. [NAME: Base(Default), Desktop, Server, QtEvent]
454+
455+
Examples:
456+
./Script/create_plugin.sh --name=Test --template=Base
457+
./Script/create_plugin.sh -n Test -t Base
458+
```
459+
460+
- [deploy.sh](../../deploy.sh): Deploy. Only used by administarotr

docs/Compile/Windows_zh_CN.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -429,3 +429,32 @@ Windows10 及以后的版本需要 [npcap](https://npcap.com)
429429

430430
CMake 使用参数 -DENABLE_UPDATE_TRANSLATIONS=ON 会自行产生资源文件,并更新资源文件。
431431
更新后,你可以直接修改 .ts 文件。
432+
433+
### 脚本
434+
435+
- [create_plugin.sh]: 从模板产生插件。
436+
437+
```
438+
k@k:/home/RabbitRemoteControl$ ./Script/create_plugin.sh -h
439+
440+
create_plugin.sh - Generate plugin from template
441+
442+
Usage: ./Script/create_plugin.sh [OPTION] PluginName
443+
444+
Options:
445+
-h, --help Show this help message
446+
-v, --verbose[=LEVEL] Set verbose mode. [LEVEL: ON, OFF]
447+
448+
Directory options:
449+
-i, --install=DIR Set installation directory
450+
451+
Other options:
452+
-n, --name=NAME Plugin name
453+
-t, --template=NAME Template name. [NAME: Base(Default), Desktop, Server, QtEvent]
454+
455+
Examples:
456+
./Script/create_plugin.sh --name=Test --template=Base
457+
./Script/create_plugin.sh -n Test -t Base
458+
```
459+
460+
- [deploy.sh](../../deploy.sh): 分发版本。仅由管理员使用。

docs/Doxygen/Chinese.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
\image html docs/Image/PluginSequenceDiagram.svg
7272
+ 用脚本从模板生成插件: Script/create_plugin.sh
7373
\code
74-
./Script/create_plugin.sh -h
74+
./Script/create_plugin.sh -h
7575
7676
create_plugin.sh - Generate plugin from template
7777

0 commit comments

Comments
 (0)