diff --git a/doc/readme.md b/doc/readme.md new file mode 100644 index 0000000..b7ff305 --- /dev/null +++ b/doc/readme.md @@ -0,0 +1,40 @@ +# Math Learning 应用 JAR 运行指南 + +## 环境准备 +- Windows 10/11,已安装 64 位 JDK 17 + +## 终端设置为 UTF-8 +为避免中文字符显示异常,请在运行前切换到 UTF-8 编码。 + +### 命令提示符(cmd) +```cmd +chcp 65001 +set JAVA_TOOL_OPTIONS=-Dfile.encoding=UTF-8 +``` + +### PowerShell +```powershell +chcp 65001 +$env:JAVA_TOOL_OPTIONS = "-Dfile.encoding=UTF-8" +[Console]::OutputEncoding = [System.Text.Encoding]::UTF8 +``` + +## 运行 JAR 包 +1. 打开对应终端,切换到 可执行JAR 所在目录: +2. 执行运行命令: + - **cmd** + ```cmd + java -jar math-learning.jar + ``` + - **PowerShell** + ```powershell + java -jar math-learning.jar + ``` + +## 项目技术要点速览 +- **语言与版本**:Java 17,采用 UTF-8 编码。 +- **界面框架**:JavaFX 21(controls 与 fxml 模块)。 +- **构建工具**:Maven,使用 `maven-jar-plugin` 与 `maven-shade-plugin` 打包并生成可执行胖 JAR。 +- **模块架构**:分层设计(认证、试题生成、JavaFX UI 视图与场景)。 +- **邮件支持**:Jakarta Mail 2.0.1,基于 `email-config.properties` 的 SMTP 配置。 +- **测试框架**:JUnit 5(jupiter-api 与 jupiter-engine)。