diff --git a/README.md b/README.md index d0069eb..9c88350 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,26 @@ 下载发布版本 [release](https://gitea.int.it2000.com.cn/airport/tele-recv/releases) +## 安装 + +解压下载文件 tele-recv-XXX.tag.gz + +如果是linux + +```Shell +tar xzvf tele-recv-XXX.tar.gz +``` + +文件包中包含两个可执行文件和一个.yaml的配置文件 + +## 配置 + +| 选项 | 含义 | 取值 | 例子 | +|------- |---------------------|-----------------|------------------------| +|device | 串口设备名称 | ttyS1 | win: COM1 linux: ttyS1 | +|baudrate| 波特率 | 9600 | 19200,38400 .... | +|lograw | 是否向控制台输出通讯内容| ture | true/false | +|file | sqlite 文件名 | telegram.db | tele.db | +|init | 是否新建电报数据库 | true | true/false | +|address | 本地处理监听端口 | 127.0.0.1:6000 | | +