fix: 更新README文档,增加临时编辑消息功能说明

This commit is contained in:
MKStoler1024 2025-01-16 22:50:23 +00:00
parent fdcc891f17
commit eef680520c

View File

@ -6,7 +6,7 @@ ExamShowboard的轻量级实现
### 本地启动
1. 填写 `exam_config.json` 文件,示例如下:
1. 填写或者用工具生成 `exam_config.json` 文件,示例如下:
```json
{
@ -47,6 +47,7 @@ ExamShowboard的轻量级实现
- 实时显示当前时间、当前考试科目、考试起止时间、剩余时间及考试状态。
- 支持全屏显示。
- 支持设置时间偏移和考场信息并保存到浏览器Cookie中。
- 支持临时编辑消息并保存到浏览器Cookie中3天后到期
## 设置说明
@ -54,22 +55,22 @@ ExamShowboard的轻量级实现
- **时间偏移**:用于调整显示的时间,单位为秒。
- **考场信息**:用于显示当前考场的名称。
- **页面缩放倍数**:用于调整页面显示的缩放倍数。
配置完成后点击保存按钮设置将会保存到浏览器的Cookie中并立即生效。
## 编辑消息
点击编辑消息按钮可以打开消息编辑窗口,进行以下操作:
- **消息内容**:用于临时编辑显示的消息。
编辑完成后点击保存按钮消息将会保存到浏览器的Cookie中并立即生效3天后到期
## 开发说明
如需对项目进行开发请确保安装Node.js和npm然后执行以下命令安装依赖
```bash
npm install
```
开发过程中可以使用以下命令启动开发服务器:
```bash
npm start
```
- 正在 `main` 分支上提供稳定版本。
- 正在 `dev` 分支上进行开发。
## 贡献