Skip to content

optimized the readme #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yaozheng-fang merged 1 commit into from
Dec 15, 2025
Merged

optimized the readme #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/content/1.introduction/2.installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@ uv init --no-workspace
# Specify Python version for the environment
uv venv --python 3.12

# Activate the virtual environment
source .venv/bin/activate

# Install AgentKit using uv
uv add agentkit-sdk-python
uv pip install agentkit-sdk-python

# Install veadk (recommended for local debugging)
uv add veadk-python

# Activate the virtual environment
source .venv/bin/activate
uv pip install veadk-python
```

### 方法三：源码安装
Expand All @@ -73,14 +73,14 @@ cd agentkit-sdk-python
# we use uv to build this project
uv venv --python 3.12

# Activate the virtual environment
source .venv/bin/activate

# only install necessary requirements
uv sync

# install agentkit-sdk-python with editable mode
uv pip install -e .

# Activate the virtual environment
source .venv/bin/activate
```

如果您习惯使用 `pip` 和 `venv`，也可以执行以下命令：
Expand Down
4 changes: 2 additions & 2 deletions docs/content/4.runtime/1.runtime_quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ source .venv/bin/activate
> 您可以通过 `--index` 参数指定镜像源以加快安装速度。

```bash
uv add veadk-python
uv add agentkit-sdk-python
uv pip install veadk-python
uv pip install agentkit-sdk-python
```

### 第 2 步：创建并本地调试 Agent
Expand Down