Skip to content

Commit 67f345f

Browse files
committed
docs: update
1 parent 7bb7363 commit 67f345f

File tree

2 files changed

+20
-18
lines changed

2 files changed

+20
-18
lines changed

README.md

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -19,30 +19,23 @@
1919
WatchCat 是一个简单易用的屏幕监控工具,专注于帮助用户实时监控屏幕内容并及时获得通知。
2020

2121
主要功能:
22+
2223
1. 🔍 **选择目标图片**:您可以选择任何想要监控的图片
2324
2. 👀 **实时监控**:自动比对屏幕内容与目标图片
2425
3. 🔔 **及时通知**:当发现匹配时,通过系统通知或音频提醒您
2526

26-
> 我开发这个程序的背景,主要是为了解决一些需要实时监控屏幕特定特征然后通报的场景
27-
>
28-
> 在监控部分,我实现了实时的高性能图像比对,允许用户自由选择本地的目标图形,并且还支持实时屏幕标注(由于系统限制不支持标注在 dock 上方
29-
>
30-
> 在通报部分,我实现了基于系统通知、基于音频通知(支持一些预设音频和本地音乐片段选择),未来还将继续支持邮件、微信等通知形式
31-
>
32-
> 在功能部分,目前还比较机械地只支持单个图片的比对,未来应该支持多个图片,甚至不同的其他输入比对形式,万物皆可比对,只要能定义好比对条件,我们要做的就是一个设定条件然后达标后友好通知的小工具,所以叫 watchcat(致敬 watchdog)
33-
>
34-
> 另外,本项目是全程由 windsurf + claude-3.5 花了两天时间做完,我本人虽然做了多年软件研发,但也确实不够熟悉 pyqt 生态,所以基本上也不懂里面的代码,甚至连实现 ctrl + c/z 退出需要在 thread 中都不知道,花了很多时间,但最多的时间还是在解决文件选择框打开之后绘制罢工的问题
35-
>
36-
> 希望对大家有帮助!也希望对这个项目感兴趣的可以多提 issue 和 pr,我会仔细看的!
27+
- [用户文档](https://cs-magic-open.github.io/watchcat/)
3728

3829
### 主要特性
3930

4031
- **高性能图像比对**
32+
4133
- 实时屏幕监控
4234
- 支持自定义目标图片
4335
- 智能匹配算法
4436

4537
- **多样化通知**
38+
4639
- 系统通知
4740
- 音频提醒(预设音效/自定义音乐)
4841
- 更多通知方式开发中
@@ -55,11 +48,13 @@ WatchCat 是一个简单易用的屏幕监控工具,专注于帮助用户实
5548
### 使用场景
5649

5750
1. **网页监控**
51+
5852
- 监控网站更新
5953
- 等待特定内容出现
6054
- 抢购提醒
6155

6256
2. **游戏通知**
57+
6358
- 监控游戏状态
6459
- 提醒重要事件
6560
- 自动通知
@@ -96,13 +91,6 @@ poetry run python -m watchcat
9691
5. 点击开始,程序会在后台运行
9792
6. 当屏幕出现匹配内容时,您会立即收到通知
9893

99-
## 文档
100-
101-
- [在线文档](https://cs-magic-open.github.io/watchcat/)
102-
- [快速入门](https://cs-magic-open.github.io/watchcat/getting-started/)
103-
- [使用指南](https://cs-magic-open.github.io/watchcat/guide/basic-usage/)
104-
- [常见问题](https://cs-magic-open.github.io/watchcat/faq/)
105-
10694
## 系统要求
10795

10896
- Python 3.9+

docs/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,17 @@ poetry run python -m watchcat
5555
## 📄 许可证
5656

5757
本项目采用 MIT 许可证 - 详见 [LICENSE](https://github.com/cs-magic-open/watchcat/blob/main/LICENSE) 文件
58+
59+
## 花絮
60+
61+
> 我开发这个程序的背景,主要是为了解决一些需要实时监控屏幕特定特征然后通报的场景
62+
>
63+
> 在监控部分,我实现了实时的高性能图像比对,允许用户自由选择本地的目标图形,并且还支持实时屏幕标注(由于系统限制不支持标注在 dock 上方
64+
>
65+
> 在通报部分,我实现了基于系统通知、基于音频通知(支持一些预设音频和本地音乐片段选择),未来还将继续支持邮件、微信等通知形式
66+
>
67+
> 在功能部分,目前还比较机械地只支持单个图片的比对,未来应该支持多个图片,甚至不同的其他输入比对形式,万物皆可比对,只要能定义好比对条件,我们要做的就是一个设定条件然后达标后友好通知的小工具,所以叫 watchcat(致敬 watchdog)
68+
>
69+
> 另外,本项目是全程由 windsurf + claude-3.5 花了两天时间做完,我本人虽然做了多年软件研发,但也确实不够熟悉 pyqt 生态,所以基本上也不懂里面的代码,甚至连实现 ctrl + c/z 退出需要在 thread 中都不知道,花了很多时间,但最多的时间还是在解决文件选择框打开之后绘制罢工的问题
70+
>
71+
> 希望对大家有帮助!也希望对这个项目感兴趣的可以多提 issue 和 pr,我会仔细看的!

0 commit comments

Comments
 (0)