Skip to content

Commit

Permalink
feat: add video
Browse files Browse the repository at this point in the history
  • Loading branch information
MarkShawn2020 committed Dec 17, 2024
1 parent f2709c6 commit 13fe347
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 9 deletions.
27 changes: 23 additions & 4 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ on:
tags:
- "v*"

permissions:
contents: write

jobs:
build:
name: Build ${{ matrix.os }}
Expand All @@ -14,9 +17,21 @@ jobs:
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
python-version: ["3.11"]
include:
- os: windows-latest
asset_name: watchcat.exe
asset_path: dist/watchcat.exe
- os: ubuntu-latest
asset_name: watchcat-linux
asset_path: dist/watchcat
- os: macos-latest
asset_name: watchcat-macos
asset_path: dist/watchcat

steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Set up Python
uses: actions/setup-python@v4
Expand Down Expand Up @@ -84,23 +99,27 @@ jobs:
run: |
poetry run pyinstaller --clean --onefile --windowed --name watchcat transparent_overlay/main.py
- name: Rename Linux/macOS binary
if: runner.os != 'Windows'
run: |
mv dist/watchcat "dist/${{ matrix.asset_name }}"
- name: Upload Release Asset
uses: softprops/action-gh-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
files: |
dist/watchcat*
files: ${{ matrix.asset_path }}
draft: false
prerelease: ${{ contains(github.ref, '-alpha') || contains(github.ref, '-beta') || contains(github.ref, '-rc') }}
generate_release_notes: true
fail_on_unmatched_files: true

- name: Upload artifacts
uses: actions/upload-artifact@v3
with:
name: watchcat-${{ matrix.os }}
path: |
dist/watchcat*
path: ${{ matrix.asset_path }}

create-release:
needs: build
Expand Down
12 changes: 7 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@
[![Poetry](https://img.shields.io/badge/poetry-managed-blue)](https://python-poetry.org/)
[![PyQt6](https://img.shields.io/badge/GUI-PyQt6-green)](https://www.riverbankcomputing.com/software/pyqt/)

![type:video](https://www.bilibili.com/video/BV11CB5YWEyM/)

## 🎯 特性

- 💫 透明覆盖窗口
- 🤖 桌面自动化
- 🎨 现代化GUI界面
- 🎨 现代化 GUI 界面
- 🔧 可扩展的插件系统
- 📦 跨平台支持

Expand All @@ -33,18 +35,18 @@ poetry run python -m watchcat

## 🛠️ 技术栈

- **PyQt6**: 现代化的GUI框架
- **Poetry**: Python依赖管理
- **PyQt6**: 现代化的 GUI 框架
- **Poetry**: Python 依赖管理
- **OpenCV**: 图像处理
- **NumPy**: 数据处理
- **MSS**: 屏幕捕获

## 📚 文档导航

- [快速开始](getting-started.md) - 5分钟上手指南
- [快速开始](getting-started.md) - 5 分钟上手指南
- [基本使用](guide/basic-usage.md) - 核心功能介绍
- [高级功能](guide/advanced.md) - 进阶使用技巧
- [API参考](api/qt-interface.md) - 详细API文档
- [API 参考](api/qt-interface.md) - 详细 API 文档

## 🤝 贡献

Expand Down
10 changes: 10 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,16 @@ markdown_extensions:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
- search
- mkdocs-video:
is_video: true
video_muted: true
video_controls: true
css_style:
width: "100%"
height: "500px"

nav:
- 主页: index.md
- 快速开始: getting-started.md
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ plyer = "^2.1.0"
notify-py = "^0.3.43"
pydub = "^0.25.1"
pydantic = "^2.10.3"
mkdocs-video = "^1.5.0"

[tool.poetry.group.linux.dependencies]
simpleaudio = { version = "^1.0.4", platform = "linux" }
Expand Down

0 comments on commit 13fe347

Please sign in to comment.