Skip to content

Commit 7f769d0

Browse files
committed
docs: update
1 parent af23211 commit 7f769d0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+73
-21176
lines changed

docs/getting-started.md

Lines changed: 42 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,59 @@
11
# 快速开始
22

3-
## 基本功能
3+
## 🎯 基本功能演示
44

5-
WatchCat 是一个简单易用的屏幕监控工具,它可以:
5+
让我们通过一个简单的例子来了解 WatchCat 的基本功能:监控下载完成。
66

7-
1. 🔍 **选择目标图片**:您可以选择任何想要监控的图片
8-
2. 👀 **实时监控**:自动比对屏幕内容与目标图片
9-
3. 🔔 **及时通知**:当发现匹配时,通过系统通知或音频提醒您
7+
### 1. 准备工作
8+
- 启动 WatchCat,找到系统托盘中的猫咪图标 🐱
9+
- 点击图标打开主界面
1010

11-
## 环境要求
11+
### 2. 设置监控
12+
1. 截取下载完成时的界面特征(比如"下载完成"按钮)
13+
2. 在 WatchCat 中点击"选择图片",选择刚才的截图
14+
3. 设置通知方式(系统通知/声音提醒)
1215

13-
- Python 3.9+
14-
- Poetry
15-
- 操作系统:
16-
- macOS 10.15+
17-
- Windows 10/11(即将支持)
18-
- Linux(即将支持)
16+
### 3. 开始监控
17+
1. 点击"开始监控"
18+
2. WatchCat 会在后台运行,持续监控屏幕
19+
3. 当下载完成时,你会立即收到通知
1920

20-
## ⚡️ 安装
21+
## 🔍 更多使用场景
2122

22-
### 1. 克隆仓库
23+
### 游戏自动化
24+
- 监控游戏中的特定场景
25+
- 自动检测对手动作
26+
- 提醒你及时响应
2327

24-
```bash
25-
git clone https://github.com/cs-magic-open/watchcat.git
26-
cd watchcat
27-
```
28+
### 数据监控
29+
- 监控股票价格变化
30+
- 检测网站更新
31+
- 追踪数据指标变化
2832

29-
### 2. 安装依赖
33+
### 工作流自动化
34+
- 监控任务完成状态
35+
- 自动化重复性操作
36+
- 提高工作效率
3037

31-
使用 Poetry 安装所有依赖:
38+
## ⚡️ 使用技巧
3239

33-
```bash
34-
poetry install
35-
```
36-
37-
### 3. 启动应用
38-
39-
```bash
40-
poetry run python -m watchcat
41-
```
42-
43-
## 🎮 使用方法
44-
45-
1. **启动应用**
46-
- 运行后会在系统托盘显示猫咪图标
47-
- 点击托盘图标打开主界面
48-
49-
2. **选择目标图片**
50-
- 点击"选择图片"按钮
51-
- 从本地选择要监控的图片
52-
53-
3. **设置通知方式**
54-
- 系统通知:默认启用
55-
- 音频提醒:可选择预设音效或本地音乐片段
56-
57-
4. **开始监控**
58-
- 点击"开始"按钮
59-
- WatchCat 会自动在后台运行
60-
- 当屏幕出现与目标图片匹配的内容时,立即通知您
61-
62-
## 使用技巧
63-
64-
1. **选择合适的图片**
40+
1. **选择合适的目标图片**
6541
- 选择特征明显的部分
66-
- 避免选择太大或太小的图片
67-
- 图片最好有独特的特征
42+
- 避免选择纯色或太复杂的区域
43+
- 图片大小适中,不要太大或太小
6844

69-
2. **通知设置**
70-
- 根据场景选择合适的通知方式
71-
- 可以同时启用多种通知
72-
- 音频通知适合需要立即注意的场景
45+
2. **设置合适的通知方式**
46+
- 重要事项建议同时开启系统通知和声音提醒
47+
- 根据场景选择合适的提示音
48+
- 可以设置通知优先级
7349

74-
3. **后台运行**
75-
- 程序会在系统托盘运行
76-
- 不会影响其他工作
77-
- 随时可以查看状态
50+
3. **优化监控性能**
51+
- 合理设置检查间隔
52+
- 适当缩小监控区域
53+
- 关闭不需要的功能
7854

79-
## 📝 下一步
55+
## 📚 下一步
8056

81-
- 查看[基本使用](guide/basic-usage.md)了解更多功能
82-
- 浏览[常见问题](faq.md)获取帮助
83-
- 通过[问题反馈](https://github.com/cs-magic-open/watchcat/issues)报告问题
57+
- [查看基础教程](guide/basic-usage.md) 了解更多功能
58+
- [浏览使用技巧](guide/tips.md) 获取进阶建议
59+
- [常见问题](faq.md) 解答你的疑惑

docs/index.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,47 @@
11
# WatchCat
22

3-
> 🚀 一个强大的桌面自动化工具,基于透明覆盖窗口技术
3+
> 🚀 完全基于 AI 开发的一款桌面自动化工具,基于透明覆盖窗口技术
44
55
[![GitHub stars](https://img.shields.io/github/stars/cs-magic-open/watchcat?style=social)](https://github.com/cs-magic-open/watchcat)
6-
[![Poetry](https://img.shields.io/badge/poetry-managed-blue)](https://python-poetry.org/)
7-
[![PyQt6](https://img.shields.io/badge/GUI-PyQt6-green)](https://www.riverbankcomputing.com/software/pyqt/)
6+
[![Release](https://img.shields.io/github/v/release/cs-magic-open/watchcat)](https://github.com/cs-magic-open/watchcat/releases)
87

98
<!-- <iframe src="//player.bilibili.com/player.html?bvid=BV11CB5YWEyM&page=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" style="width: 100%; height: 500px;"> </iframe> -->
109

10+
## ✨ 简介
11+
12+
WatchCat 是一个简单易用的桌面自动化工具,它能帮助你:
13+
14+
- 🔍 **监控屏幕变化**:自动检测屏幕上的特定内容
15+
- 🔔 **及时通知提醒**:当发现匹配时立即通知你
16+
- 🤖 **自动化操作**:可以触发自定义的自动化操作
17+
1118
## 🎯 特性
1219

13-
- 💫 透明覆盖窗口
14-
- 🤖 桌面自动化
15-
- 🎨 现代化 GUI 界面
16-
- 🔧 可扩展的插件系统
17-
- 📦 跨平台支持
20+
- 💫 **智能识别**:基于 AI 的图像识别技术
21+
- 🎨 **简单易用**:现代化的图形界面,无需编程知识
22+
- 🔧 **灵活配置**:可自定义监控区域和通知方式
23+
- 📦 **跨平台**:支持 macOS(Windows 和 Linux 即将支持)
1824

1925
## 💡 使用场景
2026

21-
- 桌面自动化测试
22-
- 界面交互录制
23-
- 自动化工作流
24-
- 屏幕监控与分析
25-
26-
## 🛠️ 技术栈
27+
- 📥 **下载监控**:及时知道下载完成
28+
- 🎮 **游戏辅助**:自动检测游戏中的特定场景
29+
- 📊 **数据监控**:监控仪表盘的数据变化
30+
- 🔄 **工作流自动化**:自动化重复性的操作
2731

28-
- **PyQt6**: 现代化的 GUI 框架
29-
- **Poetry**: Python 依赖管理
30-
- **OpenCV**: 图像处理
31-
- **NumPy**: 数据处理
32-
- **MSS**: 屏幕捕获
32+
## 🚀 开始使用
3333

34-
## 📚 文档导航
34+
1. [快速上手](getting-started.md)
35+
2. [下载安装](guide/installation.md)
36+
3. [查看教程](guide/basic-usage.md)
3537

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

41-
## 🤝 贡献
40+
WatchCat 是一个开源项目,我们欢迎任何形式的贡献:
4241

43-
欢迎贡献代码!请查看我们的[贡献指南](development/contributing.md)
42+
- 🐛 [报告问题](https://github.com/cs-magic-open/watchcat/issues)
43+
- 📝 [改进文档](development/contributing.md)
44+
- 💻 [贡献代码](development/setup.md)
4445

4546
## 📄 许可证
4647

mkdocs.yml

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,10 @@ nav:
5858
- 主页: index.md
5959
- 快速开始: getting-started.md
6060
- 用户指南:
61-
- 安装: guide/installation.md
62-
- 基本使用: guide/basic-usage.md
63-
- 高级功能: guide/advanced.md
64-
- API参考:
65-
- PyQt界面: api/qt-interface.md
66-
- 自动化功能: api/automation.md
61+
- 安装: guide/installation.md
62+
- 基本使用: guide/basic-usage.md
6763
- 开发:
68-
- 贡献指南: development/contributing.md
69-
- 开发环境搭建: development/setup.md
64+
- 贡献指南: development/contributing.md
65+
- 开发环境搭建: development/setup.md
7066
- 常见问题: faq.md
7167
- 更新日志: changelog.md

0 commit comments

Comments
 (0)