Add Version Selection

This commit is contained in:
Him188 2020-09-19 14:31:21 +08:00
parent 48f5c947b6
commit 799123c331
2 changed files with 30 additions and 3 deletions

View File

@ -14,7 +14,6 @@ Mirai 是一个在全平台下运行,提供 QQ 协议支持的高效率机器
</div>
# mirai-console
[ ![Download](https://api.bintray.com/packages/him188moe/mirai/mirai-console/images/download.svg?) ](https://bintray.com/him188moe/mirai/mirai-console/)
高效率插件支持 QQ 机器人框架, 机器人核心来自 [mirai](https://github.com/mamoe/mirai)
@ -35,6 +34,18 @@ console 由后端和前端一起工作. 使用时必须选择一个前端.
**注意:`mirai-console` 后端和 terminal 前端正在进行完全的重构, 所有 API 都不具有稳定性**
### 版本
[Version]: https://api.bintray.com/packages/him188moe/mirai/mirai-console/images/download.svg?
详见 [版本规范](docs/README.md#版本规范)
| 版本类型 | 版本号 |
|:------:|:----------:|
| 稳定 | - |
| 预览 | 1.0-M4 |
| 开发 | ![Version] |
### 使用
**查看示例插件**: [mirai-console-example-plugin](https://github.com/Him188/mirai-console-example-plugin)

View File

@ -143,12 +143,28 @@ Mirai Console 是不断前进的框架,将来必定会发生 API 弃用和重
Mirai Console 的版本号遵循 [语义化版本 2.0.0](https://semver.org/lang/zh-CN/#spec-item-9) 规范。
在大版本开发过程中Mirai Console 会以 `-M1`, `-M2` 等版本后缀发布里程碑预览版本。代表一些功能基本完成,但还不稳定。
但这些版本里新增的 API 可能还会在下一个 Milestone 版本变化,因此请按需使用。
在日常开发中, Mirai Console 会以 `-dev-1``-dev-2` 等版本后缀发布开发预览版本。这些版本仅用于兼容性测试等目的,无稳定性保证。
在大版本开发过程中Mirai Console 会以 `-M1`, `-M2` 等版本后缀发布里程碑预览版本。代表一系列功能的完成,但还不稳定。
这些版本里新增的 API 仍可能还会在下一个 Milestone 版本变化,因此请按需使用。
在大版本即将发布前Mirai Console 会以 `-RC` 版本后缀发布最终的预览版本。
`RC` 表示新版本 API 已经确定,离稳定版发布只差最后的一些内部优化或 bug 修复。
##### 版本选择
**稳定性**:稳定 (`x.y.z`) > 发布预览 (`-RC`) > 里程碑预览 (`-M`) > 开发 (`-dev`)。
| 目的 | 推荐至少更新到版本 |
|:--------------------------:|:--------------:|
| 生产环境 | `x.y.z` |
| 希望尽早体验稳定新特性的插件作者 | `-RC` |
| 无论如何都想体验新特性的插件作者 | `-M` |
| 前端实现者, 底层插件作者 | `-M` |
| 为 Mirai Console 提交 PR | `-dev` |
其中,‘底层插件’ 表示提供扩展等的插件。如权限系统,其他语言插件加载器等。
##### 更新兼容性
对于 `x.y.z` 版本号: