| 文档 | 内容 |
|---|---|
| 项目说明 | 功能概览、快速上手、部署入口、免责声明与许可证 |
| 使用教程 | 工作流、命令行、GUI、Docker 与推流的完整操作步骤 |
| 配置参数 | config/config.ini 的全部配置项、说明与默认值 |
| 更新日志 | 版本更新、功能变化与问题修复 |
| 方式 | 适用场景 | 入口 |
|---|---|---|
| GitHub Actions | 无需自备服务器，适合手动生成结果 | 工作流部署 |
| GUI | Windows 或 macOS 桌面使用 | GUI 软件 |
| 命令行 | 本地开发、调试或脚本运行 | 命令行 |
| Docker | 服务器、NAS 或长期运行 | Docker |
Important
本项目不提供数据源。请先阅读添加数据源与更多，并确保数据源及使用方式符合当地法律法规与授权要求。
| Document | Contents |
|---|---|
| Project overview | Feature overview, quick start, deployment entry points, disclaimer, and license |
| Tutorial | Complete steps for GitHub Actions, command line, GUI, Docker, and streaming |
| Configuration | Every config/config.ini option with its description and default |
| Changelog | Releases, feature changes, and fixes |
| Method | Best for | Start here |
|---|---|---|
| GitHub Actions | Manual result generation without a dedicated server | Workflow deployment |
| GUI | Desktop use on Windows or macOS | GUI Software |
| Command line | Local development, debugging, or scripts | Command Line |
| Docker | Servers, NAS devices, or long-running deployments | Docker |
Important
This project does not provide data sources. Read Add data sources and more first, and ensure that your sources and usage comply with applicable laws and authorization requirements.