From 56e57dd19431662e1ce100d5b120eaba58eb49b1 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Sun, 22 Jun 2025 07:10:51 +0000 Subject: [PATCH] Update README.md --- README.en.md | 27 +++++++++++++++++++++++++++ README.md | 31 +++++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..bc86114 --- /dev/null +++ b/README.en.md @@ -0,0 +1,27 @@ + + +# Spark-Update-Tool + +This is a Qt-based project, primarily used for developing desktop applications. The current version is 0.1, supporting C++17 standard. + +## Installation and Build + +The project uses [CMake](https://cmake.org/) for build management. The steps to install the build system dependencies are as follows: + +1. Install Qt6 or Qt5 Widgets module. +2. Ensure CMake and a C++ compiler are installed on your system. +3. During the project build, CMake will automatically handle source code installation and compilation. + +For Android builds, the CMakeLists.txt contains logic for building a shared library; for iOS or macOS, it is recommended to manually set the bundle identifier. Specific configuration details can be found in `CMakeLists.txt`. + +## Usage Instructions + +This project implements a simple main window application framework. The core code is located in `main.cpp` and `mainwindow.cpp`. The `MainWindow` class inherits from `QMainWindow` and initializes the UI within its constructor. + +To run the program, simply execute the generated binary file after the build process is completed. + +## Additional Configuration + +The project includes additional configurations tailored for Qt Creator, such as automatic code style detection and replacing tabs with spaces, to ensure code consistency and readability. Detailed settings are provided in `CMakeLists.txt.user`. + +For code analysis, the project is configured with Perf and Valgrind tools, using the `cpu-cycles` event for performance evaluation. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..6e82db9 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ + + +# Spark-Update-Tool + +这是一个基于Qt的项目,主要用于开发桌面应用程序。当前版本为0.1,支持C++17标准。 + +## 安装与构建 + +本项目使用[CMake](https://cmake.org/)进行构建管理。安装构建系统依赖项的步骤如下: + +1. 安装Qt6或Qt5的Widgets模块。 +2. 确保系统中已安装CMake和C++编译器。 +3. 构建项目时,CMake会自动处理源代码的安装与编译。 + +对于Android构建,CMakeLists.txt包含构建共享库的逻辑;对于iOS或macOS,建议手动设置bundle标识。具体配置细节可以在`CMakeLists.txt`中找到。 + +## 使用说明 + +该项目实现了一个简单的主窗口应用程序框架,核心代码在`main.cpp`和`mainwindow.cpp`中。`MainWindow`类继承自`QMainWindow`,并在构造函数中初始化了UI。 + +要运行程序,构建完成后直接执行生成的二进6.1.0)可执行文件即可。 + +## 许可证 + +未在代码库中找到明确的许可证信息。请在正式发布前确认添加合适的开源许可证。 + +## 额外配置 + +项目中包含一些针对Qt Creator的额外配置,如自动检测代码风格、空格代替Tab等,确保代码的一致性和可读性。这些配置在`CMakeLists.txt.user`中有详细描述。 + +对于代码分析,项目配置了Perf和Valgrind工具,以`cpu-cycles`事件为基础进行性能分析。 \ No newline at end of file -- Gitee