diff --git a/README.md b/README.md index 38596575147434746ecb5d1a8fd45eefb9cffea2..71ae4bc9e1a98f8996d5a23d808ef5046e2dfb8b 100644 --- a/README.md +++ b/README.md @@ -1 +1,67 @@ -multiTools使用QT5.12.12版本编译,语言编码GB2312 \ No newline at end of file +# 多功能工具箱 (multiTools) + +这是一个多功能工具箱项目,适用于嵌入式开发和测试任务。该项目基于Qt框架开发,提供了多种实用功能模块,包括串口通信、网络通信、GIF播放、固件下载、数据包生成、协议解析和数据库操作等。 + +## 主要功能模块 + +- **串口通信 (Serial Communication)** + 支持串口扫描、数据收发、协议解析、文件传输等功能。 + +- **网络通信 (Network Communication)** + 提供TCP/UDP连接支持,包括数据发送与接收、连接状态监控等。 + +- **GIF播放器 (GIF Player)** + 支持加载和播放GIF动画文件。 + +- **固件下载 (MCU Download)** + 支持固件文件的打开、校验和下载,适用于MCU编程。 + +- **数据包生成 (Upackage)** + 支持生成固件升级包,包含自动版本号管理等功能。 + +- **协议解析 (Protocol Parsing)** + 支持多种自定义协议的配置、解析和响应,包括CRC校验等功能。 + +- **数据库支持 (MySQL Database)** + 提供数据库初始化、数据插入、修改和查询功能。 + +## 使用要求 + +- 开发环境:Qt 5.x 或更高版本 +- 编译工具链:支持C++11及以上标准 +- 依赖库:Qt Core, Qt Gui, Qt Widgets, Qt SerialPort, Qt Network, MySQL Connector + +## 安装与构建 + +1. 克隆仓库到本地: + ```bash + git clone https://gitee.com/yourname/multiTools.git + ``` + +2. 打开项目并使用Qt Creator进行构建: + - 使用Qt Creator打开 `multiTools.pro` 文件。 + - 选择合适的构建套件(Kit)。 + - 点击“构建”按钮进行编译。 + +3. 运行程序: + - 点击“运行”按钮启动应用程序。 + +## 使用说明 + +- 启动程序后,可以通过主界面切换不同的功能模块。 +- 每个模块都有独立的UI界面和操作逻辑,请参考界面上的提示进行操作。 +- 日志信息会显示在相应的日志窗口中,便于调试和分析。 + +## 贡献指南 + +欢迎贡献代码和改进建议!请遵循以下步骤: + +1. Fork 本仓库。 +2. 创建新分支 (`git checkout -b feature/new-feature`)。 +3. 提交更改 (`git commit -m 'Add some feature'`)。 +4. 推送分支 (`git push origin feature/new-feature`)。 +5. 提交 Pull Request。 + +## 许可证 + +本项目采用 MIT License,请参阅 [LICENSE](LICENSE) 文件获取详细信息。 \ No newline at end of file