From 139282efdbcf8179084622515efb52be2de0ab10 Mon Sep 17 00:00:00 2001
From: "Mr.V" <vsirwork@163.com>
Date: Thu, 28 Mar 2024 20:31:47 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 58 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a939332..45e34e0 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,60 @@
 # Train_RFID
 
-RFID硬件车号识别程序
\ No newline at end of file
+
+<p>
+&nbsp;&nbsp;&nbsp;&nbsp;
+RFID硬件车号识别程序，支持识别结果上传web
+读取到RFID原数据（含磁钢）会存储到日志目录中。
+</p> 
+
+### 目录结构
+- app
+  - config 配置文件
+- resource 
+  - 图片资源
+- src 源码目录
+  - common
+  - ConfigUtil
+  - interface
+  - qt_source
+  - serial
+  - util
+
+### 配置文件
+```python
+[base]
+# 串口名
+com_name=COM2
+# 波特率
+baud=19200
+# 股道名
+track_name=2
+# 是否有磁钢
+have_magnet_steel=true
+# 需要识别的磁钢顺序
+magnet_steel_order=8421
+# 是否上传识别结果（上传接口见interface配置）
+up_result=true
+# 是否使用socket接口获取来车状态
+use_socket_server=false
+
+[interface]
+# 接口IP
+http_ip=192.168.2.108
+# 接口端口
+http_port=20004
+# 获取token的接口地址
+token_path=/api/token_path
+# 上传识别结果的接口地址
+up_result_path=/api/train-carriage/identification/rfid-save
+# 接口用户名
+username=guest_01
+# 接口密码
+password=d55b0f642e817eea24725d2f2a31dd08
+
+[socket_server]
+# socket 服务端IP
+server_ip=172.18.160.1
+# socket 端口
+server_port=7000
+```