Skip to content

Commit 04b0627

Browse files
committed
docs: update README.md
1 parent a0aa707 commit 04b0627

File tree

1 file changed

+50
-2
lines changed

1 file changed

+50
-2
lines changed

README.md

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,59 @@
1-
# RM Schedule
1+
# RoboMaster 赛程分析软件
22

3-
## Build
3+
正式环境 https://schedule.scutbot.cn/
4+
5+
这是后端仓库,前端仓库见 https://github.com/scutrobotlab/rm-schedule-ui
6+
7+
除后端技术性介绍外,其余内容都写在前端仓库的 README 中。
8+
9+
## 技术方案
10+
11+
### 依赖工具
12+
13+
- Golang 1.22
14+
- Docker
15+
16+
### 编译方式
17+
18+
直接编译
19+
20+
```bash
21+
go mod tidy
22+
go build -o rm-schedule .
23+
```
24+
25+
构建 Docker 镜像
426

527
```bash
628
docker build --platform linux/amd64 -t registry.cn-guangzhou.aliyuncs.com/scutrobot/rm-schedule:latest .
729
```
830

31+
推送 Docker 镜像
32+
933
```bash
1034
docker push registry.cn-guangzhou.aliyuncs.com/scutrobot/rm-schedule:latest
1135
```
36+
37+
### 目录结构
38+
39+
```text
40+
.
41+
├── Dockerfile
42+
├── LICENSE
43+
├── README.md
44+
├── etc 配置文件
45+
├── go.mod
46+
├── go.sum
47+
├── internal 内部代码
48+
│ ├── handler 请求处理器
49+
│ │ ├── ...
50+
│ ├── job 定时任务
51+
│ │ ├── ...
52+
│ ├── router 路由
53+
│ │ └── router.go
54+
│ ├── static 静态资源
55+
│ │ ├── ...
56+
│ └── svc 服务
57+
│ └── service_context.go
58+
└── main.go 主方法
59+
```

0 commit comments

Comments
 (0)