docs: readme (#2)

This commit is contained in:
MkStoler 2025-01-23 15:35:30 +08:00 committed by GitHub
parent d1a5e5c6d8
commit dc6f800e10
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -6,7 +6,7 @@ ExamShowboard的轻量级实现
### 本地启动 ### 本地启动
1. 填写或者用工具生成 `exam_config.json` 文件,示例如下: 1. 填写或者用[ExamShowBoard编辑器](https://github.com/examaware/DSZExamShowBoardEditor)生成 `exam_config.json` 文件,示例如下:
```json ```json
{ {
@ -27,6 +27,10 @@ ExamShowboard的轻量级实现
} }
``` ```
> [!TIP]
>
> 配置文件只要有上面内容就行了,有其他的内容(比如 `room` )也不会有影响。
2. 确保安装Python。然后执行以下命令启动本地服务器 2. 确保安装Python。然后执行以下命令启动本地服务器
```bash ```bash
@ -74,4 +78,4 @@ ExamShowboard的轻量级实现
## 贡献 ## 贡献
欢迎提交Issue和Pull Request来贡献代码。 欢迎提交Issue和Pull Request来贡献代码。