Skip to content

Commit 29654dc

Browse files
author
Zing
committed
docs: 更新文档添加问题反馈和风格包说明
添加详细的问题反馈指南和风格包说明文档,包括: - 问题反馈模板和流程 - 新增风格包功能介绍 - 更新项目文档链接 - 添加反馈渠道信息
1 parent 9fcad3d commit 29654dc

2 files changed

Lines changed: 123 additions & 1 deletion

File tree

README.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
- **丰富的 API**:提供应用管理、设备控制、图像识别、OCR 等多种功能
1616
- **方法注册系统**:支持动态注册、重写和恢复方法
1717
- **协程支持**:Lua 引擎支持协程操作
18+
- **风格包支持**:提供 autogo 和 lrappsoft 两种风格包
19+
- **懒人脚本兼容**:lrappsoft 风格包兼容大部分懒人脚本的 Lua 方法
1820
- **文档生成**:可自动生成 API 文档
1921

2022
## 安装
@@ -27,7 +29,7 @@ go get github.com/ZingYao/autogo_scriptengine@v0.0.12
2729

2830
> **🔥 重要提示**:查看以下详细文档以获取完整的 API 参考和使用指南
2931
30-
**📖 项目文档地址**[AutoGo ScriptEngine](https://zingyao.github.io/autogo_scriptengine/)
32+
**📖 项目文档地址**https://zingyao.github.io/autogo_scriptengine/
3133

3234
### 🌐 HTML 在线文档
3335

@@ -165,13 +167,53 @@ The command line is too long.
165167
- [goja](https://github.com/dop251/goja) - JavaScript 解释器
166168
- [gopher-lua](https://github.com/yuin/gopher-lua) - Lua 解释器
167169

170+
## 风格包说明
171+
172+
### autogo 风格包
173+
174+
基于 AutoGo 原生 API 开发的风格包,提供简洁、高效的 API 接口,方便开发者快速编写脚本。
175+
176+
### lrappsoft 风格包
177+
178+
基于懒人脚本 API 开发的风格包,兼容大部分懒人脚本的 Lua 方法,方便开发者快速迁移懒人的 Lua 脚本。
179+
180+
**主要特点**
181+
- 兼容懒人脚本的 API 接口
182+
- 实现了大部分懒人的 Lua 方法
183+
- 保持与懒人脚本的使用习惯一致
184+
- 支持懒人脚本的核心功能
185+
186+
**迁移指南**
187+
1. 替换导入路径:将原来的导入路径替换为 lrappsoft 风格包的路径
188+
2. 保持方法调用不变:由于 lrappsoft 风格包实现了与懒人脚本相同的方法名和参数,因此可以保持方法调用不变
189+
3. 测试脚本:运行迁移后的脚本,确保功能正常
190+
191+
## 依赖架构的重大改变
192+
193+
在本次开发了 lrappsoft 风格包后,依赖架构发生了重大改变:
194+
195+
1. **风格包分离**:将 API 实现分为 autogo 和 lrappsoft 两种风格包,提供不同的编程风格选择
196+
2. **模块化设计**:每个风格包内部采用模块化设计,便于维护和扩展
197+
3. **兼容性增强**:通过 lrappsoft 风格包,增强了与懒人脚本的兼容性
198+
4. **依赖管理**:优化了依赖管理,减少了不必要的依赖
199+
168200
## 与 AutoGo 的关系
169201

170202
本项目是 AutoGo 的扩展方案,通过封装 AutoGo 提供的原生 API,为开发者提供更灵活的脚本编写方式:
171203

172204
- **AutoGo** - 提供 Android 自动化的核心能力(无障碍服务、图像识别、触摸模拟等)
173205
- **ScriptEngine** - 为 AutoGo 添加脚本语言支持,让开发者可以用 JavaScript 或 Lua 编写自动化脚本
206+
- **风格包** - 提供不同风格的 API 接口,满足不同开发者的需求
174207

175208
## 许可证
176209

177210
MIT License
211+
212+
## 反馈渠道
213+
214+
如果您在使用过程中遇到任何问题或有任何建议,请通过以下方式反馈:
215+
216+
- **GitHub Issues**https://github.com/ZingYao/autogo_scriptengine/issues
217+
- **GitHub Discussions**https://github.com/ZingYao/autogo_scriptengine/discussions
218+
219+
欢迎提交 Issue 或 Discussion,我们会尽快回复并解决问题。

docs/README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,86 @@ The command line is too long.
205205
- **ScriptEngine** - 为 AutoGo 添加脚本语言支持,让开发者可以用 JavaScript 或 Lua 编写自动化脚本
206206
- **风格包** - 提供不同风格的 API 接口,满足不同开发者的需求
207207

208+
## 问题反馈
209+
210+
如果您在使用过程中遇到任何问题、发现 bug 或者有功能建议,欢迎通过以下方式反馈:
211+
212+
### 📝 提交 Issue
213+
214+
我们非常欢迎您在 GitHub 上提交 Issue 来反馈问题。提交 Issue 时,请尽可能提供以下信息,以便我们更快地定位和解决问题:
215+
216+
**必填信息**
217+
- 问题描述:清晰描述您遇到的问题或建议
218+
- 复现步骤:详细的操作步骤,让我们能够重现问题
219+
- 预期行为:您期望看到的结果
220+
- 实际行为:实际发生的情况
221+
222+
**环境信息**
223+
- AutoGo ScriptEngine 版本
224+
- Go 语言版本
225+
- Android 设备型号和系统版本
226+
- 使用的脚本语言(JavaScript 或 Lua)
227+
- 操作系统(Windows/macOS/Linux)
228+
229+
**可选信息**
230+
- 错误日志或堆栈信息
231+
- 最小可复现代码示例
232+
- 相关截图或录屏
233+
234+
### 🐛 Bug 反馈
235+
236+
发现 bug 时,请按照以下模板提交 Issue:
237+
238+
```markdown
239+
**Bug 描述**
240+
简要描述 bug 的表现
241+
242+
**复现步骤**
243+
1. 执行操作 A
244+
2. 执行操作 B
245+
3. 观察到错误 C
246+
247+
**预期行为**
248+
描述您期望的正常行为
249+
250+
**实际行为**
251+
描述实际发生的错误行为
252+
253+
**环境信息**
254+
- AutoGo ScriptEngine 版本:
255+
- Go 版本:
256+
- Android 版本:
257+
- 脚本语言:
258+
```
259+
260+
### 💡 功能建议
261+
262+
如果您有功能改进建议,请按照以下模板提交 Issue:
263+
264+
```markdown
265+
**功能描述**
266+
描述您希望添加或改进的功能
267+
268+
**使用场景**
269+
描述这个功能的使用场景和价值
270+
271+
**建议方案**
272+
如果您有具体的实现想法,请描述您的建议方案
273+
```
274+
275+
### 📌 Issue 标签
276+
277+
提交 Issue 时,请使用合适的标签帮助我们分类:
278+
- `bug` - 报告 bug
279+
- `enhancement` - 功能增强建议
280+
- `documentation` - 文档相关
281+
- `question` - 使用问题
282+
- `compatibility` - 兼容性问题
283+
284+
**GitHub Issues 地址**https://github.com/ZingYao/autogo_scriptengine/issues
285+
286+
在提交 Issue 前,建议先搜索现有的 Issues,确认是否已有类似问题或建议。
287+
208288
## 许可证
209289

210290
MIT License

0 commit comments

Comments
 (0)