Docs: Add detailed Pull and Run guide
This commit is contained in:
parent
f4090e05a8
commit
a08aa4f9a4
30
README.md
30
README.md
@ -7,17 +7,29 @@
|
||||
- **自动摘要**: 提炼核心观点,生成简洁摘要。
|
||||
- **互动测验**: 基于笔记内容生成选择题,帮助巩固记忆。
|
||||
|
||||
## 快速开始
|
||||
## 🛠️ 拉取与运行指南 (Installation & Run)
|
||||
|
||||
1. **安装依赖**:
|
||||
```bash
|
||||
uv sync
|
||||
```
|
||||
### 1. 克隆项目 (Clone)
|
||||
首先将项目代码拉取到本地:
|
||||
```bash
|
||||
git clone http://hblu.top:3000/st2411020215/zhangjiansunhe.git
|
||||
cd zhangjiansunhe
|
||||
```
|
||||
|
||||
2. **运行应用**:
|
||||
```bash
|
||||
uv run streamlit run app.py
|
||||
```
|
||||
### 2. 安装依赖 (Install Dependencies)
|
||||
本项目推荐使用 `uv` 进行快速包管理:
|
||||
```bash
|
||||
# 如果未安装 uv
|
||||
curl -LsSf https://astral.sh/uv/install.sh | sh
|
||||
|
||||
# 同步依赖
|
||||
uv sync
|
||||
```
|
||||
|
||||
### 3. 启动应用 (Run App)
|
||||
```bash
|
||||
uv run streamlit run app.py
|
||||
```
|
||||
|
||||
## 📖 操作指南
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user