优化README文档

This commit is contained in:
puke
2025-11-10 15:49:57 +08:00
parent 6ddb78008c
commit 178d307790
4 changed files with 10 additions and 34 deletions

View File

@@ -21,7 +21,11 @@
**零门槛,零剪辑经验**,让视频创作成为一句话的事! **零门槛,零剪辑经验**,让视频创作成为一句话的事!
---
## 🖥️ Web 界面预览
![Web UI界面](resources/webui.png)
## ✨ 功能亮点 ## ✨ 功能亮点
@@ -35,7 +39,6 @@
-**多种 AI 模型** - 支持 GPT、通义千问、DeepSeek、Ollama 等 -**多种 AI 模型** - 支持 GPT、通义千问、DeepSeek、Ollama 等
-**原子能力灵活组合** - 基于 ComfyUI 架构,可使用预置工作流,也可自定义任意能力(如替换生图模型为 FLUX、替换 TTS 为 ChatTTS 等) -**原子能力灵活组合** - 基于 ComfyUI 架构,可使用预置工作流,也可自定义任意能力(如替换生图模型为 FLUX、替换 TTS 为 ChatTTS 等)
---
## 📊 视频生成流程 ## 📊 视频生成流程
@@ -47,7 +50,6 @@ Pixelle-Video 采用模块化设计,整个视频生成流程清晰简洁:
每个环节都支持灵活定制,可选择不同的 AI 模型、音频引擎、视觉风格等,满足个性化创作需求。 每个环节都支持灵活定制,可选择不同的 AI 模型、音频引擎、视觉风格等,满足个性化创作需求。
---
## 🎬 视频示例 ## 🎬 视频示例
@@ -111,7 +113,6 @@ Pixelle-Video 采用模块化设计,整个视频生成流程清晰简洁:
> 💡 **提示**: 这些视频都是通过输入一个主题关键词,由 AI 全自动生成的,无需任何视频剪辑经验! > 💡 **提示**: 这些视频都是通过输入一个主题关键词,由 AI 全自动生成的,无需任何视频剪辑经验!
---
## 🚀 快速开始 ## 🚀 快速开始
@@ -129,7 +130,6 @@ Pixelle-Video 采用模块化设计,整个视频生成流程清晰简洁:
> 💡 **提示**: 整合包已包含所有依赖,无需手动安装任何环境。首次使用只需配置 API 密钥即可。 > 💡 **提示**: 整合包已包含所有依赖,无需手动安装任何环境。首次使用只需配置 API 密钥即可。
---
### 从源码安装(适合 macOS / Linux 用户或需要自定义的用户) ### 从源码安装(适合 macOS / Linux 用户或需要自定义的用户)
@@ -163,7 +163,6 @@ sudo apt install ffmpeg
安装完成后,在终端中运行 `ffmpeg -version` 验证安装成功。 安装完成后,在终端中运行 `ffmpeg -version` 验证安装成功。
---
#### 第一步:下载项目 #### 第一步:下载项目
@@ -189,13 +188,11 @@ uv run streamlit run web/app.py
配置好后点击「保存配置」,就可以开始生成视频了! 配置好后点击「保存配置」,就可以开始生成视频了!
---
## 💻 使用方法 ## 💻 使用方法
打开 Web 界面后,你会看到三栏布局,下面详细讲解每个部分: 打开 Web 界面后,你会看到三栏布局,下面详细讲解每个部分:
---
### ⚙️ 系统配置(首次必填) ### ⚙️ 系统配置(首次必填)
@@ -226,7 +223,6 @@ uv run streamlit run web/app.py
配置完成后点击「保存配置」。 配置完成后点击「保存配置」。
---
### 📝 内容输入(左侧栏) ### 📝 内容输入(左侧栏)
@@ -243,7 +239,6 @@ uv run streamlit run web/app.py
- **自定义音乐**: 将你的音乐文件MP3/WAV 等)放到 `bgm/` 文件夹 - **自定义音乐**: 将你的音乐文件MP3/WAV 等)放到 `bgm/` 文件夹
- 点击「试听 BGM」可以预览音乐 - 点击「试听 BGM」可以预览音乐
---
### 🎤 语音设置(中间栏) ### 🎤 语音设置(中间栏)
@@ -261,7 +256,6 @@ uv run streamlit run web/app.py
- 输入测试文本,点击「预览语音」即可试听效果 - 输入测试文本,点击「预览语音」即可试听效果
- 支持使用参考音频进行预览 - 支持使用参考音频进行预览
---
### 🎨 视觉设置(中间栏) ### 🎨 视觉设置(中间栏)
@@ -292,7 +286,6 @@ uv run streamlit run web/app.py
- 如果懂 HTML可以在 `templates/` 文件夹创建自己的模板 - 如果懂 HTML可以在 `templates/` 文件夹创建自己的模板
- 🔗 [查看所有模板效果图](https://aidc-ai.github.io/Pixelle-Video/zh/user-guide/templates/#_3) - 🔗 [查看所有模板效果图](https://aidc-ai.github.io/Pixelle-Video/zh/user-guide/templates/#_3)
---
### 🎬 生成视频(右侧栏) ### 🎬 生成视频(右侧栏)
@@ -310,7 +303,6 @@ uv run streamlit run web/app.py
- 显示视频时长、文件大小、分镜数等信息 - 显示视频时长、文件大小、分镜数等信息
- 视频文件保存在 `output/` 文件夹 - 视频文件保存在 `output/` 文件夹
---
### ❓ 常见问题 ### ❓ 常见问题
@@ -333,7 +325,6 @@ A: **本项目完全支持免费运行!**
**选择建议**:本地有显卡建议完全免费方案,否则推荐使用通义千问(性价比高) **选择建议**:本地有显卡建议完全免费方案,否则推荐使用通义千问(性价比高)
---
## 🤝 参考项目 ## 🤝 参考项目
@@ -347,7 +338,6 @@ Pixelle-Video 的设计受到以下优秀开源项目的启发:
感谢这些项目的开源精神!🙏 感谢这些项目的开源精神!🙏
---
## 📢 反馈与支持 ## 📢 反馈与支持
@@ -355,13 +345,11 @@ Pixelle-Video 的设计受到以下优秀开源项目的启发:
- 💡 **功能建议**: 提交 [Feature Request](https://github.com/AIDC-AI/Pixelle-Video/issues) - 💡 **功能建议**: 提交 [Feature Request](https://github.com/AIDC-AI/Pixelle-Video/issues)
-**给个 Star**: 如果这个项目对你有帮助,欢迎给个 Star 支持一下! -**给个 Star**: 如果这个项目对你有帮助,欢迎给个 Star 支持一下!
---
## 📝 许可证 ## 📝 许可证
本项目采用 Apache 2.0 许可证,详情请查看 [LICENSE](LICENSE) 文件。 本项目采用 Apache 2.0 许可证,详情请查看 [LICENSE](LICENSE) 文件。
---
## ⭐ Star History ## ⭐ Star History

View File

@@ -21,7 +21,11 @@ Just input a **topic**, and Pixelle-Video will automatically:
**Zero threshold, zero editing experience** - Make video creation as simple as typing a sentence! **Zero threshold, zero editing experience** - Make video creation as simple as typing a sentence!
---
## 🖥️ Web Interface Preview
![Web UI Interface](resources/webui_en.png)
## ✨ Key Features ## ✨ Key Features
@@ -35,7 +39,6 @@ Just input a **topic**, and Pixelle-Video will automatically:
-**Multiple AI Models** - Support GPT, Qwen, DeepSeek, Ollama and more -**Multiple AI Models** - Support GPT, Qwen, DeepSeek, Ollama and more
-**Flexible Atomic Capability Combination** - Based on ComfyUI architecture, can use preset workflows or customize any capability (such as replacing image generation model with FLUX, replacing TTS with ChatTTS, etc.) -**Flexible Atomic Capability Combination** - Based on ComfyUI architecture, can use preset workflows or customize any capability (such as replacing image generation model with FLUX, replacing TTS with ChatTTS, etc.)
---
## 📊 Video Generation Pipeline ## 📊 Video Generation Pipeline
@@ -47,7 +50,6 @@ From input text to final video output, the entire process is clear and simple: *
Each step supports flexible customization, allowing you to choose different AI models, audio engines, visual styles, etc., to meet personalized creation needs. Each step supports flexible customization, allowing you to choose different AI models, audio engines, visual styles, etc., to meet personalized creation needs.
---
## 🎬 Video Examples ## 🎬 Video Examples
@@ -111,7 +113,6 @@ Here are actual cases generated using Pixelle-Video, showcasing video effects wi
> 💡 **Tip**: All these videos are fully automatically generated by AI just by inputting a topic keyword, without any video editing experience required! > 💡 **Tip**: All these videos are fully automatically generated by AI just by inputting a topic keyword, without any video editing experience required!
---
## 🚀 Quick Start ## 🚀 Quick Start
@@ -129,7 +130,6 @@ Here are actual cases generated using Pixelle-Video, showcasing video effects wi
> 💡 **Tip**: The package includes all dependencies, no need to manually install any environment. On first use, you only need to configure API keys. > 💡 **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) ### Install from Source (For macOS / Linux Users or Users Who Need Customization)
@@ -163,7 +163,6 @@ sudo apt install ffmpeg
After installation, run `ffmpeg -version` in the terminal to verify successful installation. After installation, run `ffmpeg -version` in the terminal to verify successful installation.
---
#### Step 1: Clone Project #### Step 1: Clone Project
@@ -189,13 +188,11 @@ On first use, expand the "⚙️ System Configuration" panel and fill in:
After configuration, click "Save Configuration", and you can start generating videos! After configuration, click "Save Configuration", and you can start generating videos!
---
## 💻 Usage ## 💻 Usage
After opening the Web interface, you will see a three-column layout. Here's a detailed explanation of each part: After opening the Web interface, you will see a three-column layout. Here's a detailed explanation of each part:
---
### ⚙️ System Configuration (Required on First Use) ### ⚙️ System Configuration (Required on First Use)
@@ -226,7 +223,6 @@ Used for generating video images.
After configuration, click "Save Configuration". After configuration, click "Save Configuration".
---
### 📝 Content Input (Left Column) ### 📝 Content Input (Left Column)
@@ -243,7 +239,6 @@ After configuration, click "Save Configuration".
- **Custom Music**: Put your music files (MP3/WAV, etc.) in the `bgm/` folder - **Custom Music**: Put your music files (MP3/WAV, etc.) in the `bgm/` folder
- Click "Preview BGM" to preview music - Click "Preview BGM" to preview music
---
### 🎤 Voice Settings (Middle Column) ### 🎤 Voice Settings (Middle Column)
@@ -261,7 +256,6 @@ After configuration, click "Save Configuration".
- Enter test text, click "Preview Voice" to listen to the effect - Enter test text, click "Preview Voice" to listen to the effect
- Supports using reference audio for preview - Supports using reference audio for preview
---
### 🎨 Visual Settings (Middle Column) ### 🎨 Visual Settings (Middle Column)
@@ -292,7 +286,6 @@ Determines video layout and design.
- If you know HTML, you can create your own templates in the `templates/` folder - If you know HTML, you can create your own templates in the `templates/` folder
- 🔗 [View All Template Previews](https://aidc-ai.github.io/Pixelle-Video/user-guide/templates/#built-in-template-preview) - 🔗 [View All Template Previews](https://aidc-ai.github.io/Pixelle-Video/user-guide/templates/#built-in-template-preview)
---
### 🎬 Generate Video (Right Column) ### 🎬 Generate Video (Right Column)
@@ -310,7 +303,6 @@ Determines video layout and design.
- Shows video duration, file size, number of frames, etc. - Shows video duration, file size, number of frames, etc.
- Video files are saved in the `output/` folder - Video files are saved in the `output/` folder
---
### ❓ FAQ ### ❓ FAQ
@@ -333,7 +325,6 @@ A: **This project fully supports free operation!**
**Selection Suggestion**: If you have a local GPU, recommend completely free solution, otherwise recommend using Qwen (cost-effective) **Selection Suggestion**: If you have a local GPU, recommend completely free solution, otherwise recommend using Qwen (cost-effective)
---
## 🤝 Referenced Projects ## 🤝 Referenced Projects
@@ -347,7 +338,6 @@ Pixelle-Video design is inspired by the following excellent open-source projects
Thanks for the open-source spirit of these projects! 🙏 Thanks for the open-source spirit of these projects! 🙏
---
## 📢 Feedback and Support ## 📢 Feedback and Support
@@ -355,13 +345,11 @@ Thanks for the open-source spirit of these projects! 🙏
- 💡 **Feature Suggestions**: Submit [Feature Request](https://github.com/AIDC-AI/Pixelle-Video/issues) - 💡 **Feature Suggestions**: Submit [Feature Request](https://github.com/AIDC-AI/Pixelle-Video/issues)
-**Give a Star**: If this project helps you, feel free to give a Star for support! -**Give a Star**: If this project helps you, feel free to give a Star for support!
---
## 📝 License ## 📝 License
This project is released under the Apache License 2.0. For details, please see the [LICENSE](LICENSE) file. This project is released under the Apache License 2.0. For details, please see the [LICENSE](LICENSE) file.
---
## ⭐ Star History ## ⭐ Star History

BIN
resources/webui.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 115 KiB

BIN
resources/webui_en.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB