Skip to content
This repository was archived by the owner on Jan 27, 2026. It is now read-only.

Commit b556863

Browse files
committed
docs: 更新 README.md
1 parent 843f756 commit b556863

File tree

1 file changed

+16
-30
lines changed

1 file changed

+16
-30
lines changed

README.md

Lines changed: 16 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
ClassIsland 集控服务器。
44

5-
> **注意:本项目是ClassIsland集控服务器。如果您要查找ClassIsland软件本体,请前往仓库[ClassIsland/ClassIsland](https://github.com/ClassIsland/ClassIsland)**
5+
> **注意:本项目是 ClassIsland 集控服务器。如果您要查找 ClassIsland 软件本体,请前往仓库[ClassIsland/ClassIsland](https://github.com/ClassIsland/ClassIsland)**
66
77
## 功能
88

@@ -22,69 +22,55 @@ ClassIsland 集控服务器。
2222
- [x] 分发策略
2323
- [x] 分发设置信息
2424
- [x] 分发档案信息
25-
- [x] 使用grpc向客户端发送命令
25+
- [x] 使用 grpc 向客户端发送命令
2626
- [ ] 向客户端发送提醒
2727
- [ ] 通知客户端更新数据
2828

2929
### API
3030

31-
- [x] API返回分页
31+
- [x] API 返回分页
3232

3333
### WebUI
34+
3435
- [x] 批量创建对象
3536
- [x] 管理并分组实例
3637
- [x] 管理并分组档案(课表、时间表、科目)信息
3738
- [x] 上传档案信息
3839
- [ ] 从表格导入课表
39-
- [ ] 管理并分组策略
40+
- [x] 管理并分组策略
4041
- [x] 管理并分组默认设置
4142

4243
### 用户
44+
4345
- [x] 用户创建与管理
44-
- [ ] 用户鉴权
45-
- [ ] 用户角色(管理员,教师,访客等)
46+
- [x] 用户鉴权
47+
- [x] 用户角色(管理员,教师,访客等)
4648

4749
## 开始使用(预览)
4850

4951
**请确保您的设备满足以下推荐需求:**
5052

5153
- Windows / Linux 系统
52-
- [ASP.NET Core 8.0 运行时](https://dotnet.microsoft.com/zh-cn/download/dotnet/8.0)
54+
- 已安装[ASP.NET Core 8.0 运行时](https://dotnet.microsoft.com/zh-cn/download/dotnet/8.0)
55+
- 已安装[MySQL 8.0]
5356

5457
> [!IMPORTANT]
55-
>
5658
> **本版本为预览版,仅用于测试和开发环境,请勿在生产环境中使用。**
57-
> 如您是普通用户,建议等待官方发布构建版本。
58-
59-
---
59+
> 目前项目还在早期开发阶段,可能会出现对数据结构的破坏性更改。
6060
61-
对于开发者或高级用户,您可以从以下渠道获取本软件的预览版本:
61+
### 下载软件
6262

63-
### 获取安装包
64-
65-
1. 访问 [GitHub Actions - ManagementServer](https://github.com/ClassIsland/ManagementServer/actions) 页面
66-
2. 选择最新左侧带对勾的Action进入
67-
3. 在 “Summayr” 底部下载适用于您平台的压缩包文件
63+
- [GitHub Releases](https://github.com/ClassIsland/ManagementServer/releases)
6864

6965
### 安装步骤
7066

7167
1. 将压缩包解压到一个**独立的文件夹**(路径中请勿包含中文或特殊字符)
7268
> ⚠️ 请勿将程序解压至网盘同步目录、【下载】文件夹等可能存在访问限制的路径,否则可能导致**文件读写失败、配置丢失**等问题。
73-
2.`data/appsettings.example.json` 文件复制为 `appsettings.json`(位于程序主目录下)
74-
3. 创建数据库,并记录数据库地址、用户名、密码及数据库名称
75-
4. 编辑 `appsettings.json` 文件:
76-
- 修改 `ConnectionStrings.Production` 键值:
77-
1. 替换 `{Your Host}` 为数据库服务器地址(无需端口,如 `localhost`
78-
2. 替换 `{User Id}` 为数据库用户名
79-
3. 替换 `{Your Password}` 为数据库密码
80-
4. 替换 `classisland_management` 为实际使用的数据库名
81-
- 添加/修改键 `DatabaseType``mysql`(目前仅支持 MySQL)
82-
5. 如果您是 Windows 用户,可直接运行 `.ps1` 启动脚本启动服务
83-
6. 如果您是 Linux 用户,并希望长期运行服务,可参考[此文档](https://blog.csdn.net/Pan_peter/article/details/128875714)进行配置
69+
2. 切换到安装目录,然后运行 `setup.ps1`/`setup.sh` 运行安装向导
70+
3. 安装向导完成后,运行 `start.ps1`/`start.sh` 启动服务
71+
4. 如果您是 Linux 用户,并希望长期运行服务,可参考[此文档](https://blog.csdn.net/Pan_peter/article/details/128875714)进行配置
8472

8573
> [!NOTE]
8674
> 如果您遇到任何问题,请前往 [ClassIsland.ManagementServer GitHub 仓库](https://github.com/ClassIsland/ManagementServer) 提交 issue 或查阅相关讨论内容。
8775
88-
8976
**🚧本项目还在开发中**
90-

0 commit comments

Comments
 (0)