Skip to content

Commit d263bb9

Browse files
authored
Merge pull request #8 from fhz08/master
修改了README.md文件
2 parents 2bdafb6 + 0a5d1fb commit d263bb9

File tree

3 files changed

+78
-9
lines changed

3 files changed

+78
-9
lines changed

README.md

Lines changed: 78 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,90 @@
1-
# dsz-exam-composer
1+
# DSZ考试展板
2+
3+
![view](image/README/view.png)
4+
5+
[![stars](https://img.shields.io/github/stars/hello8693DSZ/dsz-exam-showboard?label=Stars)](https://github.com/hello8693DSZ/dsz-exam-showboard)
6+
[![Release](https://img.shields.io/github/downloads/hello8693DSZ/dsz-exam-showboard/total?style=social&label=Downloads&logo=github)](https://github.com/hello8693DSZ/dsz-exam-showboard/releases/latest)
7+
[![Beta](https://img.shields.io/github/v/release/hello8693DSZ/dsz-exam-showboard?include_prereleases&style=social-square&label=测试版)](https://github.com/hello8693DSZ/dsz-exam-showboard/releases/)
8+
9+
## 软件介绍
10+
- 您可以查看下方的详细介绍
11+
- 使用Vue + TypeScript + JavaScript制作,使用Node.js+Electron完善系统级功能并打包。
12+
- 欢迎给作者点个右上角的Star或者给作者宣传一波
13+
- [【点我加群】DSZ考试看板QQ交流群: 901670561](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=TIGkmk-8lHUtUj_D4BVZ95tY-MMA1IwF&authKey=2TIKZ838Aq7vWGyiMKx9vwi%2B1MfHqpCv7NZ4XpTl4QhpAW03ac7x8Gc%2FnnOougVi&noverify=0&group_code=901670561)
14+
15+
## 功能
16+
17+
### 展示考试信息
18+
- [X] 展示考试名称
19+
- [X] 展示当前时间
20+
- [X] 展示当前考试科目名称
21+
- [X] 展示考试开始,结束时间
22+
- [X] 展示考试状态
23+
24+
### 其他功能
25+
- [X] 考试结束十五分钟前预警
26+
- [ ] 集控管理(正在开发中)
27+
28+
## 软件截图
29+
30+
### 主界面截图
31+
![main](image/README/main.png)
32+
33+
### 考试界面截图
34+
![view](image/README/view.png)
35+
36+
## 开始使用
37+
### 下载
38+
对于普通用户,可以在以下渠道下载到本软件
39+
40+
下载 [Realeases](https://github.com/hello8693DSZ/dsz-exam-showboard/releases) | [Actions](https://github.com/hello8693DSZ/dsz-exam-showboard/actions)
41+
42+
### 准备配置文件
43+
#### 新建格式为`json`的配置文件,模板如下
44+
```json
45+
{
46+
"examName": "",
47+
"message": "",
48+
"examInfos": [
49+
{
50+
"name": "",
51+
"start": "XXXX-XX-XXTXX:XX:XX",
52+
"end": "XXXX-XX-XXTXX:XX:XX"
53+
}
54+
]
55+
}
56+
```
57+
58+
### 运行
59+
下载完成后,将软件双击运行,等待进度条走完,双击运行桌面上的名为ExamShowboard的快捷方式
260

3-
An Electron application with Vue and TypeScript
61+
### 导入配置
62+
进入主界面后,点击打开配置按钮,选择您已配置好的配置文件,下次进入时可点击直接进入看板按钮进入考试看板,继续使用上次加载的配置文件。
463

5-
## Recommended IDE Setup
64+
## 开发
65+
要在本地编译应用您需要安装以下负载和工具
666

767
- [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) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin)
868

9-
## 注意事项
69+
### 注意事项
1070

1171
必须使用Yarn包管理。Node版本要求为20。
1272

13-
## Project Setup
73+
### Project Setup
1474

15-
### Install
75+
#### 安装
1676

1777
```bash
1878
$ yarn
1979
```
2080

21-
### Development
81+
#### Development
2282

2383
```bash
2484
$ yarn dev
2585
```
2686

27-
### Build
87+
#### 构建
2888

2989
```bash
3090
# For windows
@@ -37,6 +97,15 @@ $ yarn build:mac
3797
$ yarn build:linux
3898
```
3999

40-
## 说明
100+
### 说明
41101

42102
如果dev模式页面不显示或按钮点击无效等问题,请连续刷新至少3次后再进行操作。build后没有此问题。
103+
104+
我们欢迎想要为本应用实现新功能或进行改进的同学提交 [Pull Request](https://github.com/hello8693DSZ/dsz-exam-showboard/pulls)
105+
106+
## Stars 历史
107+
108+
[![Star 历史](https://starchart.cc/hello8693DSZ/dsz-exam-showboard.svg?variant=adaptive)](https://starchart.cc/hello8693DSZ/dsz-exam-showboard)
109+
110+
<div align="center">
111+

image/README/main.png

25.9 KB
Loading

image/README/view.png

62.6 KB
Loading

0 commit comments

Comments
 (0)