📝 update guide docs

This commit is contained in:
yanyongyu
2020-12-01 12:24:14 +08:00
parent ad994f04fc
commit a085b47eac
6 changed files with 76 additions and 83 deletions

View File

@ -6,14 +6,34 @@
请确保你的 Python 版本 >= 3.7。
:::
:::warning 注意
请在安装 nonebot2 之前卸载 nonebot 1.x
```bash
pip uninstall nonebot
```
:::
### 通过脚手架安装(推荐安装方式)
1. (可选)使用你喜欢的 Python 环境管理工具创建新的虚拟环境。
2. 使用 `pip` (或其他) 安装 NoneBot 脚手架。
```bash
pip install nb-cli
```
### 不使用脚手架(纯净安装)
```bash
# poetry
poetry add nonebot2
# pip
pip install nonebot2
```
如果你需要使用最新的(可能尚未发布的)特性,可以直接从 GitHub 仓库安装:
如果你需要使用最新的(可能**尚未发布**的)特性,可以直接从 GitHub 仓库安装:
```bash
# master
@ -30,57 +50,3 @@ cd nonebot2
poetry install --no-dev # 推荐
pip install . # 不推荐
```
## 额外依赖
### APScheduler
A task scheduling library for Python.
可用于计划任务,后台执行任务等
```bash
pip install nonebot2[scheduler]
poetry add nonebot2[scheduler]
```
[![apscheduler](https://img.shields.io/github/stars/agronholm/apscheduler?style=social)](https://github.com/agronholm/apscheduler)
### NoneBot-Test
A test frontend for nonebot2.
通过前端展示 nonebot 已加载的插件以及运行状态,同时可以用于模拟发送事件测试机器人
```bash
pip install nonebot2[test]
poetry add nonebot2[test]
```
[![nonebot-test](https://img.shields.io/github/stars/nonebot/nonebot-test?style=social)](https://github.com/nonebot/nonebot-test)
### CLI
CLI for nonebot2.
一个多功能脚手架
```bash
pip install nonebot2[cli]
poetry add nonebot2[cli]
```
[![nb-cli](https://img.shields.io/github/stars/nonebot/nb-cli?style=social)](https://github.com/yanyongyu/nb-cli)
### 我全都要
```bash
pip install nonebot2[full]
poetry add nonebot2[full]
```
```bash
pip install nonebot2[cli,scheduler]
poetry add nonebot2[cli,scheduler]
```