Skip to content

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

docs: add uv prerequisites to bot readme (#341)

Alex Tang91a5cb4ec7ba
diff --git a/bot/README.md b/bot/README.md
index f1c1c5365..da0993bbf 100644
--- a/bot/README.md
+++ b/bot/README.md
@@ -5,12 +5,33 @@
## 📦 Install
+**Prerequisites**
+
+First, install [uv](https://github.com/astral-sh/uv) (an extremely fast Python package installer):
+
+```bash
+# macOS/Linux
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Windows
+powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
**Install from source** (latest features, recommended for development)
```bash
git clone https://github.com/volcengine/OpenViking
cd OpenViking/bot
-source .venv/bin/activate
+
+# Create a virtual environment using Python 3.11 or higher
+# uv will automatically fetch the required Python version if it's missing
+uv venv --python 3.11
+
+# Activate environment
+source .venv/bin/activate # macOS/Linux
+# .venv\Scripts\activate # Windows
+
+# Install dependencies
uv pip install -e .
```
diff --git a/bot/README_CN.md b/bot/README_CN.md
index 80e7cc175..7d8a4b79b 100644
--- a/bot/README_CN.md
+++ b/bot/README_CN.md
@@ -15,12 +15,32 @@ Vikingbot 深度集成 OpenViking,提供强大的知识管理和记忆检索
## 📦 安装
+**前置要求**
+
+首先安装 [uv](https://github.com/astral-sh/uv)(一个极速的 Python 包安装器):
+
+```bash
+# macOS/Linux
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Windows
+powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
**从源码安装**(最新功能,推荐用于开发)
```bash
git clone https://github.com/volcengine/OpenViking
cd OpenViking/bot
-source .venv/bin/activate
+
+# 创建 Python 3.11 或更高版本 虚拟环境
+uv venv --python 3.11
+
+# 激活环境
+source .venv/bin/activate # macOS/Linux
+# .venv\Scripts\activate # Windows
+
+# 安装依赖
uv pip install -e .
```