mirror of
https://hub.gitmirror.com/https://github.com/ExamAware/ExamShowboard-Legacy.git
synced 2025-04-29 13:46:32 +00:00
更新 README.md
This commit is contained in:
parent
efb08968e1
commit
c43a37624d
83
README.md
83
README.md
@ -9,35 +9,36 @@
|
|||||||

|

|
||||||

|

|
||||||
|
|
||||||
[](https://github.com/MKStoler4096/dsz-exam-showboard-next/stargazers)
|
[](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/stargazers)
|
||||||
[](https://github.com/MKStoler4096/dsz-exam-showboard-next/forks)
|
[](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/forks)
|
||||||
[](https://github.com/MKStoler4096/dsz-exam-showboard-next/watchers)
|
[](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/watchers)
|
||||||
[](https://github.com/MKStoler4096/dsz-exam-showboard-next/releases)
|
[](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/releases)
|
||||||
[](https://github.com/MKStoler4096/dsz-exam-showboard-next/issues)
|
[](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/issues)
|
||||||
[](https://github.com/MKStoler4096/dsz-exam-showboard-next/discussions)
|
[](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/discussions)
|
||||||
[](https://github.com/MKStoler4096/dsz-exam-showboard-next)
|
[](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next)
|
||||||
[](https://github.com/MKStoler4096/dsz-exam-showboard-next/commits/master)
|
[](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/commits/master)
|
||||||
[](https://github.com/MKStoler4096/dsz-exam-showboard-next)
|
[](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next)
|
||||||
[](https://github.com/MKStoler4096/dsz-exam-showboard-next)
|
[](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next)
|
||||||
[](LICENSE)
|
[](LICENSE)
|
||||||
[](https://qm.qq.com/q/zDiEipHsaI)
|
[](https://qm.qq.com/q/zDiEipHsaI)
|
||||||
|
|
||||||
一款显示当前时间与考试详细信息的看板类软件
|
一款显示当前时间与考试详细信息的看板类软件
|
||||||
|
|
||||||
| 下载 | [Releases](https://github.com/MKStoler4096/dsz-exam-showboard-next/releases) | [Actions](https://github.com/MKStoler4096/dsz-exam-showboard-next/actions) |
|
| 下载 | [Releases](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/releases) | [Actions](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/actions) |
|
||||||
| ---- | ---------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
| ---- | ---------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
> [!tip] > **本软件使用`Vue` + `TypeScript` + `JavaScript`制作,使用`Node.js` + `Electron`完善系统级功能并打包。**
|
> [!tip]
|
||||||
|
> **本软件使用 `Vue` + `TypeScript` + `JavaScript` 制作,使用 `Node.js` + `Electron` 完善系统级功能并打包。**
|
||||||
|
|
||||||
## 功能
|
## 功能
|
||||||
|
|
||||||
- 起始页展示`打开配置`、`直接进入看板`按钮
|
- 起始页展示 `打开配置` 、 `直接进入看板` 按钮
|
||||||
- 看板页面
|
- 看板页面
|
||||||
- 上方展示`考试标题`、`信息`
|
- 上方展示 `考试标题` 、 `信息`
|
||||||
- 左侧展示`当前时间`、`当前科目`、`考试时间`、`考试状态`
|
- 左侧展示 `当前时间` 、 `当前科目` 、 `考试时间` 、 `考试状态`
|
||||||
- 右侧展示考试科目列表,包括`科目`、`开始`、`结束`、`状态`
|
- 右侧展示考试科目列表,包括 `科目` 、 `开始` 、 `结束` 、 `状态`
|
||||||
- 考试结束前15分钟黄字提醒
|
- 考试结束前15分钟黄字提醒
|
||||||
- 集控功能(早期测试)
|
- 集控功能(早期测试)
|
||||||
|
|
||||||
@ -45,11 +46,11 @@
|
|||||||
|
|
||||||
- 下载安装程序并运行
|
- 下载安装程序并运行
|
||||||
|
|
||||||
默认安装在`AppData\Local\Programs\dsz-exam-showboard`
|
默认安装路径 `AppData\Local\Programs\dsz-exam-showboard`
|
||||||
|
|
||||||
- 编写`json`配置文件
|
- 编写 `json` 配置文件
|
||||||
|
|
||||||
新建文件`exam_config.json`,模板如下
|
新建文件 `exam_config.json` ,模板如下
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@ -70,26 +71,32 @@
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
- 打开软件,进入起始页面,点击`打开配置`按钮,选择配置文件,下次可点击`直接进入看板`按钮,将继续使用上次加载的配置。
|
- 打开软件,进入起始页面,点击 `打开配置` 按钮,选择配置文件,下次可点击 `直接进入看板` 按钮,将继续使用上次加载的配置。
|
||||||
|
- 集控(仿照 [`ClassIsland` 集控使用方法](https://docs.classisland.tech/management/tutorial-create-management-config.html))
|
||||||
- 集控
|
- 新建 GitHub 公开存储仓库
|
||||||
|
- 上传上面提到的 `exam_config.json` 文件
|
||||||
仿照 `ClassIsland` 的集控方法,把上面提到的 `exam_config.json` 传上去,获得 `raw` 直链粘贴回文本框并保存即可。
|
- 复制 `raw` 直链粘贴到应用文本框并保存
|
||||||
|
|
||||||
## 遇到问题
|
## 遇到问题
|
||||||
|
|
||||||
💡 如果您遇到`Bug`,或需要提出`优化`建议或新的`功能`,请提交[`Issues`](https://github.com/MKStoler4096/dsz-exam-showboard-next/issues)或在[`Discussions`](https://github.com/MKStoler4096/dsz-exam-showboard-next/discussions)中讨论。
|
💡 如果您遇到 `Bug` ,或需要提出`优化`建议或新的`功能`,请提交 [`Issues`](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/issues) 或在 [`Discussions`](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/discussions) 中讨论。
|
||||||
|
|
||||||
👥 您也可以加入[`QQ群|901670561`](https://qm.qq.com/q/zDiEipHsaI)获取帮助或交流讨论。
|
👥 您也可以加入 [`QQ群|901670561`](https://qm.qq.com/q/zDiEipHsaI)获取帮助或交流讨论。
|
||||||
|
|
||||||
🛠️ 欢迎为本软件进行改进或编写新功能提交[`Pull Request`](https://github.com/MKStoler4096/dsz-exam-showboard-next/pulls)
|
🛠️ 欢迎为本软件进行改进或编写新功能提交 [`Pull Request`](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/pulls)
|
||||||
|
|
||||||
## 开发
|
## 开发
|
||||||
|
|
||||||
### 推荐开发环境
|
### 推荐开发环境
|
||||||
|
|
||||||
- [VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
|
- [VSCode](https://code.visualstudio.com/)
|
||||||
> [!Caution] > **必须使用Yarn包管理。Node版本要求为20。**
|
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
||||||
|
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
|
||||||
|
- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
|
||||||
|
|
||||||
|
> [!Caution]
|
||||||
|
>
|
||||||
|
> **必须使用 Yarn 包管理。Node 版本要求为20。**
|
||||||
|
|
||||||
### 工程构建
|
### 工程构建
|
||||||
|
|
||||||
@ -109,9 +116,9 @@ $ yarn start
|
|||||||
|
|
||||||
> [!note]
|
> [!note]
|
||||||
>
|
>
|
||||||
> **如果dev模式页面不显示或按钮点击无效等问题,请连续刷新至少3次后再进行操作。build后没有此问题。**
|
> **如果 dev 模式页面不显示或按钮点击无效等问题,请连续刷新至少3次后再进行操作。 build 后没有此问题。**
|
||||||
|
|
||||||
#### 生成
|
#### 构建
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# For windows
|
# For windows
|
||||||
@ -126,19 +133,21 @@ $ yarn build:linux
|
|||||||
|
|
||||||
### 开发进度
|
### 开发进度
|
||||||
|
|
||||||
- 正在[`master`](https://github.com/MKStoler4096/dsz-exam-showboard-next/commits/master)分支上维护`1.2-Yesod`版本。
|
- 正在 [`master`](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/commits/master) 分支上维护`1.2-Yesod`版本。
|
||||||
|
|
||||||
- 正在[`dev`](https://github.com/MKStoler4096/dsz-exam-showboard-next/commits/dev)分支上开发`1.3-HOD`版本。
|
- 正在 [`dev`](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/commits/dev) 分支上开发`1.3-HOD`版本。
|
||||||
|
|
||||||
> [!note]
|
## 贡献者
|
||||||
> **如果dev模式页面不显示或按钮点击无效等问题,请连续刷新至少3次后再进行操作。build后没有此问题。**
|
|
||||||
|
<!-- readme: collaborators,contributors -start -->
|
||||||
|
<!-- readme: collaborators,contributors -end -->
|
||||||
|
|
||||||
## Stars 历史
|
## Stars 历史
|
||||||
|
|
||||||
[](https://starchart.cc/MKStoler4096/dsz-exam-showboard-next/stargazers)
|
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
|
[](https://starchart.cc/ProjectCampus-CH/dsz-exam-showboard-next/stargazers)
|
||||||
|
|
||||||
如果这个项目对您有帮助,请点亮 Star [⭐](#dsz-exam-showboard-next)
|
如果这个项目对您有帮助,请点亮 Star [⭐](#dsz-exam-showboard-next)
|
||||||
|
|
||||||
</div>
|
</div>
|
Loading…
x
Reference in New Issue
Block a user