feat(docs): 更新文档,添加项目结构和部署指南,优化快速上手部分

This commit is contained in:
2026-01-29 21:35:20 +08:00
parent 351ed0b063
commit f2bf1e4ca5
6 changed files with 437 additions and 186 deletions

View File

@@ -1,30 +1,24 @@
# 快速上手
runit
## 1. 你需要准备
* **Python 3.14**: 必须是这个版本别问我为什么。。。
* **Git**: 拉取代码
* **Redis**: 装一个
* **脑子和手**: 这个最重要,或者你去问问镀铬酸钾,会给你一对一教学的。。。
* **OneBot v11 客户端**: 机器人本体,推荐用 [NapCatQQ](https://github.com/NapNeko/NapCatQQ)
* **Python 3.14**必须是这个版本JIT编译需要
* **Git**拉取代码
* **Redis**:缓存和权限管理,需要单独安装
* **Docker** (可选)用于代码沙箱执行code_py插件
* **OneBot v11 客户端**机器人本体,推荐用 [NapCatQQ](https://github.com/NapNeko/NapCatQQ)
## 2. 搭起来
## 2. 搭环境
### a. 克隆代码
找个你喜欢的地方,把代码从 GitHub 上clone下来
```bash
git clone [项目仓库地址]
cd [项目目录]
git clone https://github.com/Fairy-Oracle-Sanctuary/NeoBot.git
cd NeoBot
```
### b. 创建虚拟环境
别把你的系统环境搞得乱七八糟
```bash
# Windows
python -m venv venv
@@ -39,17 +33,12 @@ source venv/bin/activate
### c. 安装依赖
```bash
pip install -r requirements.txt
```
这个文件里包含了所有需要的 Python 库,比如 `aiohttp` (HTTP 请求), `orjson` (JSON 解析), `jinja2` (模板渲染), `psutil` (系统监控) 等等。
### d. 安装 Playwright 依赖
我们用 Playwright 来截图画画,它需要一个浏览器核心。
```bash
playwright install chromium
```