diff --git a/README.md b/README.md index 5b6be3d..eae25eb 100644 --- a/README.md +++ b/README.md @@ -53,41 +53,10 @@ 默认安装路径 `AppData\Local\Programs\exam-showboard` -- 编写 `json` 配置文件 +- 编写 `json` 配置文件
+ - 您可以前往[ `ExamShowBoardEditor`](https://github.com/ProjectCampus-CH/DSZExamShowBoardEditor/releases)获取生成软件
+ - 您可以按照[手动编写 `json` 配置文件](https://github.com/ProjectCampus-CH/exam-showboard-next/tree/master/doc/Manually-write-JSON-configuration-file.md)教程编写配置文件 -新建文件 `exam_config.json` ,模板如下 - -> [!warning] -> -> 请确保 `exam_config.json` 文件编码为 `UTF-8`,换行符为 `LF`,按照`json`文件格式填写。不然可能会出一些神奇的 Bug。 -> -> 不确定?可以使用 [VSCode](https://code.visualstudio.com/) 打开、编辑文件,右下角显示编码格式和换行方式,点击即可更改。 - -```json -{ - "examName": "考试名称", - "message": "信息", - "room": "考场号", - "examInfos": [ - { - "name": "科目", - "start": "2024-12-01T07:00:00", - "end": "2024-12-01T08:00:00" - }, - { - "name": "科目/科目", - "start": "2024-12-01T09:00:00", - "end": "2024-12-01T10:00:00" - } - ] -} -``` - -> [!tip] -> -> `message` 与 `room` 内容必填(可填空格隐藏),`examInfos` 至少需要一条数据。 -> -> 如果有两个以"/"分隔的科目可以自动转化为双行显示 - 打开软件,进入起始页面,点击 `打开配置` 按钮,选择配置文件 - 或使用集控(仿照 [`ClassIsland` 集控使用方法](https://docs.classisland.tech/management/tutorial-create-management-config.html)) diff --git a/doc/Manually-write-JSON-configuration-file.md b/doc/Manually-write-JSON-configuration-file.md new file mode 100644 index 0000000..febdfe4 --- /dev/null +++ b/doc/Manually-write-JSON-configuration-file.md @@ -0,0 +1,34 @@ +# 手动编写json配置文件教程
+## 新建文件 `exam_config.json` ,模板如下 + +> [!warning] +> +> 请确保 `exam_config.json` 文件编码为 `UTF-8`,换行符为 `LF`,按照`json`文件格式填写。不然可能会出一些神奇的 Bug。 +> +> 不确定?可以使用 [VSCode](https://code.visualstudio.com/) 打开、编辑文件,右下角显示编码格式和换行方式,点击即可更改。 + +```json +{ + "examName": "考试名称", + "message": "信息", + "room": "考场号", + "examInfos": [ + { + "name": "科目", + "start": "2024-12-01T07:00:00", + "end": "2024-12-01T08:00:00" + }, + { + "name": "科目/科目", + "start": "2024-12-01T09:00:00", + "end": "2024-12-01T10:00:00" + } + ] +} +``` + +> [!tip] +> +> `message` 与 `room` 内容必填(可填空格隐藏),`examInfos` 至少需要一条数据。 +> +> 如果有两个以"/"分隔的科目可以自动转化为双行显示 \ No newline at end of file