From a08aa4f9a424a6d8583876ee4961a792c918b93b Mon Sep 17 00:00:00 2001 From: xyz Date: Fri, 9 Jan 2026 11:20:21 +0800 Subject: [PATCH] Docs: Add detailed Pull and Run guide --- README.md | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 44a230d..d37f363 100644 --- a/README.md +++ b/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 +``` ## 📖 操作指南