obs-overlay-widget/QUICK-SETUP.md
2025-06-27 17:30:23 +08:00

48 lines
1.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 🚀 快速部署指南
## 准备工作
1. **Fork或下载此项目**
2. **更新GitHub用户名**
### 在Windows上
```cmd
setup-readme.bat YOUR_GITHUB_USERNAME
```
### 在Linux/Mac上
```bash
chmod +x setup-readme.sh
./setup-readme.sh YOUR_GITHUB_USERNAME
```
### 手动更新:
如果脚本无法运行请手动替换README.md中所有的`USERNAME`为你的GitHub用户名。
## 部署到GitHub Pages
1. **提交更改**
```bash
git add .
git commit -m "Setup project for deployment"
git push origin main
```
2. **启用GitHub Pages**
- 访问你的GitHub仓库
- 进入 Settings → Pages
- Source 选择 "GitHub Actions"
3. **等待部署完成**
- 查看Actions页面的构建状态
- 几分钟后访问:`https://YOUR_GITHUB_USERNAME.github.io/obs-overlay-widget/`
## 验证部署
✅ 构建状态正常
✅ 网站可以访问
✅ 小组件配置正常工作
✅ 预览链接生成正确
恭喜你的OBS小组件工具已经成功部署🎉