diff --git a/README.md b/README.md index 6cbddaf..e805b18 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,92 @@ -# C++程序课程设计 +# C++ 课程设计 -这是一个简单的课程设计软件,使用SQLite3作为储存数据的部分,使用了CMake作为编译管理工具,具体在自己的平台上编译请参照CMake的使用流程。 +这个仓库包含一个用C++编写的简单课程设计软件。该应用程序使用SQLite3进行数据存储,并使用CMake进行构建管理。它提供了一个基于菜单的界面,用于用户认证和管理用户以及停车相关记录。 -# FAQ +## 目录 -## Windows 用户遇到乱码解决 +- [项目描述](#项目描述) +- [安装](#安装) +- [使用](#使用) +- [贡献](#贡献) +- [许可证](#许可证) -当 Windows 用户遇到了程序乱码问题,请先在Powershell中运行如下命令即可解决: +## 项目描述 -```pwsh -chcp 65001 -``` \ No newline at end of file +这个项目是一个C++应用程序,旨在管理用户数据和停车相关记录。它使用SQLite3作为数据库后端,并为用户提供一个基于文本的菜单驱动界面来与系统交互。该应用程序支持用户认证(登录),并提供各种操作,例如添加、查看、更新和删除用户和停车相关数据的记录。 + +关键特性包括: +- 用户认证系统 +- 菜单驱动界面用于数据库操作 +- 支持管理用户记录和停车相关记录 +- 两种构建变体:一种针对GBK编码(例如,适用于中文Windows系统),一种针对UTF-8编码 + +该项目是作为C++编程课程的一部分开发的,重点关注数据库集成和用户界面设计。 + +## 安装 + +要构建并运行此项目,请按照以下步骤操作: + +### 先决条件 +- **CMake 3.31或更高版本**:需要进行构建管理。 +- **SQLite3开发库**:需要数据库功能。 + +### 步骤 +1. **克隆仓库**: + ```bash + git clone https://git.goldbro.top/goldbro/CourseDesignInCPP.git + cd CourseDesignInCPP + ``` + +2. **创建一个构建目录并运行CMake**: + ```bash + mkdir build + cd build + cmake .. + ``` + +3. **构建项目**: + - 在类Unix系统上(例如,Linux、macOS): + ```bash + cmake --build . + ``` + +这将生成两个可执行文件: +- `coursedesign_gbk`:针对GBK编码的系统(例如,中文Windows)。 +- `coursedesign_utf8`:针对UTF-8编码的系统。 + +## 使用 + +- **运行应用程序**: + - 根据系统的字符编码选择适当的可执行文件: + - 对于GBK编码(例如,中文Windows):`./coursedesign_gbk` + - 对于UTF-8编码:`./coursedesign_utf8` + +- **数据库**: + - 应用程序使用名为`user_data.db`的SQLite数据库文件,如果它不存在,将在当前工作目录中自动创建。 + +- **交互**: + - 启动应用程序后,您将被提示登录。 + - 登录成功后,将显示一个菜单,其中包含各种操作选项,例如: + - 添加用户记录 + - 添加停车相关记录 + - 查看记录 + - 更新记录 + - 删除记录 + - 退出应用程序 + - 按照屏幕上的指示执行所需的操作。 + +### 注意 +- 应用程序设计为基于控制台的交互,因此请确保在终端或命令提示符中运行它。 +- GBK版本(`coursedesign_gbk`)针对使用GBK编码的系统进行了优化,而UTF-8版本(`coursedesign_utf8`)针对使用UTF-8编码的系统。 + +## 贡献 + +欢迎对这个项目进行贡献!如果您发现任何问题或有改进建议,请: +- 在仓库中打开一个问题。 +- 提交一个包含您更改的拉取请求。 + +请确保任何贡献都符合项目的编码标准,并包含适当的文档。 + +## 许可证 + +这个项目采用AGPL-3.0许可证。有关更多细节,请参阅仓库中的[LICENSE](LICENSE)文件。 \ No newline at end of file