From 69bb8d6f37953205f6119a0197342df49a0bc9ec Mon Sep 17 00:00:00 2001 From: puke <1129090915@qq.com> Date: Sun, 9 Nov 2025 22:43:46 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0Windows=E4=B8=80=E9=94=AE?= =?UTF-8?q?=E6=95=B4=E5=90=88=E5=8C=85=E7=9B=B8=E5=85=B3=E7=9A=84=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 30 ++++++++++++++++++++----- README_EN.md | 30 ++++++++++++++++++++----- docs/en/getting-started/installation.md | 21 ++++++++++++++++- docs/en/getting-started/quick-start.md | 8 +++++++ docs/en/index.md | 2 ++ docs/zh/getting-started/installation.md | 21 ++++++++++++++++- docs/zh/getting-started/quick-start.md | 8 +++++++ docs/zh/index.md | 2 ++ packaging/windows/README.md | 8 +++---- 9 files changed, 112 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 8e2c680..214423d 100644 --- a/README.md +++ b/README.md @@ -115,18 +115,36 @@ Pixelle-Video 采用模块化设计,整个视频生成流程清晰简洁: ## 🚀 快速开始 -### 前置环境依赖 +### 🪟 Windows 一键整合包(推荐 Windows 用户使用) + +**无需安装 Python、uv 或 ffmpeg,一键开箱即用!** + +👉 **[下载 Windows 一键整合包](https://github.com/AIDC-AI/Pixelle-Video/releases/latest)** + +1. 下载最新的 Windows 一键整合包并解压 +2. 双击运行 `start.bat` 启动 Web 界面 +3. 浏览器会自动打开 http://localhost:8501 +4. 在「⚙️ 系统配置」中配置 LLM API 和图像生成服务 +5. 开始生成视频! + +> 💡 **提示**: 整合包已包含所有依赖,无需手动安装任何环境。首次使用只需配置 API 密钥即可。 + +--- + +### 从源码安装(适合 macOS / Linux 用户或需要自定义的用户) + +#### 前置环境依赖 在开始之前,需要先安装 Python 包管理器 `uv` 和视频处理工具 `ffmpeg`: -#### 安装 uv +##### 安装 uv 请访问 uv 官方文档查看适合你系统的安装方法: 👉 **[uv 安装指南](https://docs.astral.sh/uv/getting-started/installation/)** 安装完成后,在终端中运行 `uv --version` 验证安装成功。 -#### 安装 ffmpeg +##### 安装 ffmpeg **macOS** ```bash @@ -147,14 +165,14 @@ sudo apt install ffmpeg --- -### 第一步:下载项目 +#### 第一步:下载项目 ```bash git clone https://github.com/AIDC-AI/Pixelle-Video.git cd Pixelle-Video ``` -### 第二步:启动 Web 界面 +#### 第二步:启动 Web 界面 ```bash # 使用 uv 运行(推荐,会自动安装依赖) @@ -163,7 +181,7 @@ uv run streamlit run web/app.py 浏览器会自动打开 http://localhost:8501 -### 第三步:在 Web 界面配置 +#### 第三步:在 Web 界面配置 首次使用时,展开「⚙️ 系统配置」面板,填写: - **LLM 配置**: 选择 AI 模型(如通义千问、GPT 等)并填入 API Key diff --git a/README_EN.md b/README_EN.md index a73a2f7..d79bb80 100644 --- a/README_EN.md +++ b/README_EN.md @@ -115,18 +115,36 @@ Here are actual cases generated using Pixelle-Video, showcasing video effects wi ## 🚀 Quick Start -### Prerequisites +### 🪟 Windows All-in-One Package (Recommended for Windows Users) + +**No need to install Python, uv, or ffmpeg - ready to use out of the box!** + +👉 **[Download Windows All-in-One Package](https://github.com/AIDC-AI/Pixelle-Video/releases/latest)** + +1. Download the latest Windows All-in-One Package and extract it +2. Double-click `start.bat` to launch the Web interface +3. Browser will automatically open http://localhost:8501 +4. Configure LLM API and image generation service in "⚙️ System Configuration" +5. Start generating videos! + +> 💡 **Tip**: The package includes all dependencies, no need to manually install any environment. On first use, you only need to configure API keys. + +--- + +### Install from Source (For macOS / Linux Users or Users Who Need Customization) + +#### Prerequisites Before starting, you need to install Python package manager `uv` and video processing tool `ffmpeg`: -#### Install uv +##### Install uv Please visit the uv official documentation to see the installation method for your system: 👉 **[uv Installation Guide](https://docs.astral.sh/uv/getting-started/installation/)** After installation, run `uv --version` in the terminal to verify successful installation. -#### Install ffmpeg +##### Install ffmpeg **macOS** ```bash @@ -147,14 +165,14 @@ After installation, run `ffmpeg -version` in the terminal to verify successful i --- -### Step 1: Clone Project +#### Step 1: Clone Project ```bash git clone https://github.com/AIDC-AI/Pixelle-Video.git cd Pixelle-Video ``` -### Step 2: Launch Web Interface +#### Step 2: Launch Web Interface ```bash # Run with uv (recommended, will automatically install dependencies) @@ -163,7 +181,7 @@ uv run streamlit run web/app.py Browser will automatically open http://localhost:8501 -### Step 3: Configure in Web Interface +#### Step 3: Configure in Web Interface On first use, expand the "⚙️ System Configuration" panel and fill in: - **LLM Configuration**: Select AI model (such as Qwen, GPT, etc.) and enter API Key diff --git a/docs/en/getting-started/installation.md b/docs/en/getting-started/installation.md index 1c0605c..6f04c50 100644 --- a/docs/en/getting-started/installation.md +++ b/docs/en/getting-started/installation.md @@ -19,7 +19,26 @@ This page will guide you through installing Pixelle-Video. --- -## Installation Steps +## 🪟 Windows All-in-One Package (Recommended for Windows Users) + +**No need to install Python, uv, or ffmpeg - ready to use out of the box!** + +### Download and Install + +1. Visit [GitHub Releases](https://github.com/AIDC-AI/Pixelle-Video/releases/latest) to download the latest version +2. Download the latest Windows All-in-One Package and extract it to any directory +3. Double-click `start.bat` to launch the Web interface +4. Your browser will automatically open `http://localhost:8501` + +!!! success "Installation Complete!" + The package includes all dependencies, no need to manually install any environment. On first use, you only need to configure API keys in "⚙️ System Configuration" to get started. + +!!! tip "Next Steps" + After installation, check out the [Configuration Guide](configuration.md) to set up LLM and image generation services, then see [Quick Start](quick-start.md) to create your first video. + +--- + +## Install from Source (For macOS / Linux Users or Users Who Need Customization) ### Step 1: Clone the Repository diff --git a/docs/en/getting-started/quick-start.md b/docs/en/getting-started/quick-start.md index 7ba8a52..1f30aba 100644 --- a/docs/en/getting-started/quick-start.md +++ b/docs/en/getting-started/quick-start.md @@ -6,6 +6,14 @@ Already installed and configured? Let's create your first video! ## Start the Web Interface +### Windows All-in-One Package Users + +If you're using the Windows All-in-One Package, simply: +1. Double-click `start.bat` +2. Your browser will automatically open `http://localhost:8501` + +### Install from Source Users + ```bash # Using uv uv run streamlit run web/app.py diff --git a/docs/en/index.md b/docs/en/index.md index 825e0b2..76b095f 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -52,6 +52,8 @@ Simply input a **topic**, and Pixelle-Video will automatically: Ready to get started? Just three steps: 1. **[Install Pixelle-Video](getting-started/installation.md)** - Download and install the project + - 🪟 **Windows Users (Recommended)**: Use the [All-in-One Package](https://github.com/AIDC-AI/Pixelle-Video/releases/latest), no Python installation required + - 💻 **macOS/Linux Users**: Install from source, see [Installation Guide](getting-started/installation.md) 2. **[Configure Services](getting-started/configuration.md)** - Set up LLM and image generation services 3. **[Create Your First Video](getting-started/quick-start.md)** - Start creating your first video diff --git a/docs/zh/getting-started/installation.md b/docs/zh/getting-started/installation.md index 37c9a4c..00144de 100644 --- a/docs/zh/getting-started/installation.md +++ b/docs/zh/getting-started/installation.md @@ -19,7 +19,26 @@ --- -## 安装步骤 +## 🪟 Windows 一键整合包(推荐 Windows 用户使用) + +**无需安装 Python、uv 或 ffmpeg,一键开箱即用!** + +### 下载和安装 + +1. 访问 [GitHub Releases](https://github.com/AIDC-AI/Pixelle-Video/releases/latest) 下载最新版本 +2. 下载最新的 Windows 一键整合包并解压到任意目录 +3. 双击运行 `start.bat` 启动 Web 界面 +4. 浏览器会自动打开 `http://localhost:8501` + +!!! success "安装完成!" + 整合包已包含所有依赖,无需手动安装任何环境。首次使用只需在「⚙️ 系统配置」中配置 API 密钥即可开始使用。 + +!!! tip "下一步" + 安装完成后,请查看 [配置说明](configuration.md) 来设置 LLM 和图像生成服务,然后查看 [快速开始](quick-start.md) 生成第一个视频。 + +--- + +## 从源码安装(适合 macOS / Linux 用户或需要自定义的用户) ### 第一步:克隆项目 diff --git a/docs/zh/getting-started/quick-start.md b/docs/zh/getting-started/quick-start.md index 83c4fcb..62c6669 100644 --- a/docs/zh/getting-started/quick-start.md +++ b/docs/zh/getting-started/quick-start.md @@ -6,6 +6,14 @@ ## 启动 Web 界面 +### Windows 一键整合包用户 + +如果你使用的是 Windows 一键整合包,只需: +1. 双击运行 `start.bat` +2. 浏览器会自动打开 `http://localhost:8501` + +### 从源码安装用户 + ```bash # 使用 uv 运行 uv run streamlit run web/app.py diff --git a/docs/zh/index.md b/docs/zh/index.md index dae3880..f1eec77 100644 --- a/docs/zh/index.md +++ b/docs/zh/index.md @@ -52,6 +52,8 @@ 想马上体验?只需三步: 1. **[安装 Pixelle-Video](getting-started/installation.md)** - 下载并安装项目 + - 🪟 **Windows 用户推荐**: 使用 [一键整合包](https://github.com/AIDC-AI/Pixelle-Video/releases/latest),无需安装 Python 环境 + - 💻 **macOS/Linux 用户**: 从源码安装,详见 [安装指南](getting-started/installation.md) 2. **[配置服务](getting-started/configuration.md)** - 配置 LLM 和图像生成服务 3. **[生成第一个视频](getting-started/quick-start.md)** - 开始创作你的第一个视频 diff --git a/packaging/windows/README.md b/packaging/windows/README.md index 9699430..dfb2c20 100644 --- a/packaging/windows/README.md +++ b/packaging/windows/README.md @@ -39,7 +39,7 @@ The build process creates: ``` dist/windows/ -├── Pixelle-Video-v0.1.0-win64/ # Build directory +├── Pixelle-Video-v*-win64/ # Build directory (version number varies) │ ├── python/ # Python embedded │ ├── tools/ # FFmpeg, etc. │ ├── Pixelle-Video/ # Project files @@ -49,8 +49,8 @@ dist/windows/ │ ├── start_api.bat # API launcher │ ├── start_web.bat # Web launcher │ └── README.txt # User guide -├── Pixelle-Video-v0.1.0-win64.zip # ZIP package -└── Pixelle-Video-v0.1.0-win64.zip.sha256 # Checksum +├── Pixelle-Video-v*-win64.zip # ZIP package (version number varies) +└── Pixelle-Video-v*-win64.zip.sha256 # Checksum (version number varies) ``` ## Build Process @@ -205,7 +205,7 @@ Users verify download: ```bash # Windows PowerShell -Get-FileHash Pixelle-Video-v0.1.0-win64.zip -Algorithm SHA256 +Get-FileHash Pixelle-Video-v*-win64.zip -Algorithm SHA256 ``` Compare with `.sha256` file.