Skip to content

Commit 0fb2251

Browse files
committed
feat: supply quickstart
1 parent 7595448 commit 0fb2251

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

docs/docs/quickstart.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,44 @@ veadk --version
2020
请查看[Python 安装指南](https://www.python.org/downloads/)了解如何安装 Python。
2121

2222
??? note "了解如何从源码构建 VeADK"
23-
请查看[安装](https://volcengine.github.io/veadk-python/introduction/installation)章节中“从源码构建”部分,了解如何从源码构建 VeADK。
23+
1. 下载源码至本地
24+
将VeADK的代码包从Github下载到本地
25+
```bash
26+
git clone https://github.com/volcengine/veadk-python.git
27+
cd veadk-python
28+
```
29+
2. 配置`uv`环境
30+
本项目使用`uv`进行构建,(了解如何[安装`uv`](https://docs.astral.sh/uv/getting-started/installation/)
31+
```bash
32+
# 选择 3.10及以上版本
33+
uv venv --python 3.10
34+
```
35+
激活`uv`虚拟环境
36+
=== "Linux"
37+
```bash
38+
source .venv/bin/activate
39+
```
40+
=== "MacOS"
41+
```bash
42+
source .venv/bin/activate
43+
```
44+
=== "Windows CMD"
45+
```bash
46+
.venv\Scripts\activate.bat
47+
```
48+
=== "Windows PowerShell"
49+
```bash
50+
.venv\Scripts\activate.ps1
51+
```
52+
安装 VeADK
53+
```bash
54+
uv pip install .
55+
# 或以本地可编辑模式安装
56+
# uv pip install -e .
57+
```
2458

2559
??? note "了解如何为 VeADK 贡献代码"
26-
请查看[贡献指南](contributing.md)了解如何为 VeADK 项目贡献代码。
60+
请查看[贡献指南](./references/contributing.md)了解如何为 VeADK 项目贡献代码。
2761

2862
## 生成并运行
2963

0 commit comments

Comments
 (0)