From 5920efb6c5a7b28004f7c0db7d5b7670141584c6 Mon Sep 17 00:00:00 2001 From: Ju4tCode <42488585+yanyongyu@users.noreply.github.com> Date: Sun, 22 Jan 2023 15:18:26 +0800 Subject: [PATCH] =?UTF-8?q?:memo:=20Docs:=20=E4=BF=AE=E6=94=B9=E6=9B=B4?= =?UTF-8?q?=E6=96=B0=E9=83=A8=E5=88=86=E6=96=87=E6=A1=A3=20(#1615)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 19 +++++++++++++++---- website/docs/start/installation.mdx | 14 +++++++++++--- website/docs/start/nb-cli.md | 9 ++++----- 3 files changed, 30 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 87d24045..d7b6cc5a 100644 --- a/README.md +++ b/README.md @@ -135,12 +135,17 @@ NoneBot2 不是 NoneBot1 的替代品。事实上,它们都在被积极的维 懒得看文档?下面是快速安装指南: -1. (**强烈建议**)使用你喜欢的 Python 环境管理工具创建新的虚拟环境。 - -2. 使用 `pip` (或其他) 安装 NoneBot 脚手架。 +1. 安装 [pipx](https://pypa.github.io/pipx/) ```bash - pip install nb-cli + python -m pip install --user pipx + python -m pipx ensurepath + ``` + +2. 安装脚手架 + + ```bash + pipx install nb-cli ``` 3. 使用脚手架创建项目 @@ -149,6 +154,12 @@ NoneBot2 不是 NoneBot1 的替代品。事实上,它们都在被积极的维 nb create ``` +4. 运行项目 + + ```bash + nb run + ``` + ## 社区资源 ### 常见问题 diff --git a/website/docs/start/installation.mdx b/website/docs/start/installation.mdx index e579ff3d..c2a84919 100644 --- a/website/docs/start/installation.mdx +++ b/website/docs/start/installation.mdx @@ -27,13 +27,21 @@ pip uninstall nonebot ## 通过脚手架安装(推荐) -1. (可选)使用你喜欢的 Python 环境管理工具(如 Poetry、venv、Conda 等)创建新的虚拟环境 -2. 使用 pip 或其他包管理工具安装 nb-cli,NoneBot2 会作为其依赖被一起安装 +1. 安装 [pipx](https://pypa.github.io/pipx/) ```bash - pip install nb-cli + python -m pip install --user pipx + python -m pipx ensurepath ``` +2. 安装脚手架 + + ```bash + pipx install nb-cli + ``` + +安装完成后,你可以在命令行使用 `nb` 命令来使用脚手架。如果出现无法找到命令的情况(例如:`Command not found`),请参考 [pipx 文档](https://pypa.github.io/pipx/) 检查你的环境变量。 + 。 + ## 安装 ```bash -pip install nb-cli +pipx install nb-cli ``` ## 初次使用 @@ -21,14 +23,11 @@ pip install nb-cli 在安装完成之后,即可在命令行使用 nb-cli 的命令 `nb` 进行开发: ```bash -# 直接使用 nb 命令 nb -# 或使用 Python 执行 module -python -m nb_cli ``` :::warning 注意 -通常情况下,你可以直接在命令行使用 `nb` 命令,但如果命令行出现 `Command not found` 错误,这是由于环境变量 `PATH` 没有正确配置或未配置导致的,可以使用第二种方式代替。 +通常情况下,你可以直接在命令行使用 `nb` 命令。如果出现无法找到命令的情况(例如:`Command not found`),请参考 [pipx 文档](https://pypa.github.io/pipx/) 检查你的环境变量。 ::: ## 使用方式