From 38eacb9a5774890155bd37063219a7091caa132b Mon Sep 17 00:00:00 2001 From: LaizyBoy Date: Wed, 6 May 2026 21:03:51 +0800 Subject: [PATCH] =?UTF-8?q?docs(gpsrelaysentinel):=20=E9=87=8D=E6=96=B0?= =?UTF-8?q?=E6=95=B4=E7=90=86README.md=E9=A1=B9=E7=9B=AE=E8=AF=B4=E6=98=8E?= =?UTF-8?q?=E4=B9=A6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 基于项目实际情况重新组织文档结构 - 使用Markdown语法完善项目说明 - 补充技术栈、模块说明、依赖库等详细信息 - 添加项目结构、使用说明和参与贡献指南 - 更新项目名称为GPSRelaySentinel --- gpsrelaysentinel/README.md | 132 +++++++++++++++++++++++++++++-------- 1 file changed, 106 insertions(+), 26 deletions(-) diff --git a/gpsrelaysentinel/README.md b/gpsrelaysentinel/README.md index 7d41393..71122c3 100644 --- a/gpsrelaysentinel/README.md +++ b/gpsrelaysentinel/README.md @@ -1,37 +1,117 @@ -# WinBoLL +# GPSRelaySentinel -#### 介绍 -WinBoLL 网站浏览器。 +## 介绍 -#### 软件架构 -适配安卓应用 [AIDE Pro] 的 Gradle 编译结构。 -也适配安卓应用 [AndroidIDE] 的 Gradle 编译结构。 +GPSRelaySentinel 是一款基于安卓平台的综合工具应用,集成 Termux 终端模拟器、二维码扫描、网络请求等功能。 +## 技术栈 -#### Gradle 编译说明 -调试版编译命令 :gradle assembleBetaDebug -阶段版编译命令 :bash .winboll/bashPublishAPKAddTag.sh winboll +- **编程语言**: Java 7(源码) +- **编译环境**: Java 11(Gradle 编译) +- **Gradle 插件**: 7.2.1 +- **安卓 API**: + - 最低支持: API 26 (Android 8.0) + - 目标版本: API 30 (Android 11) + - 编译版本: API 30 -#### 使用说明 -3. Termux应用配置: -- 已安装Termux(包名 com.termux ); -- 执行  echo "allow-external-apps = true" > ~/.termux/termux.properties +## 软件架构 -#### 参与贡献 +适配以下安卓开发环境的 Gradle 编译结构: +- AIDE Pro +- AndroidIDE -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 : ZhanGSKen(ZhanGSKen) -4. 新建 Pull Request +## 模块说明 +本项目采用多模块结构: +- `gpsrelaysentinel` - 主应用模块 +- `libappbase` - 基础库模块(提供 OkHttp、Gson、JSch 等基础能力) +- `libaes` - AES 加密库模块(提供权限请求、二维码、拼音搜索等扩展功能) -#### 特技 +## 核心依赖库 -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +### 网络相关 +- OkHttp 4.4.1 / 3.14.9 - HTTP 客户端 +- Gson 2.10.1 - JSON 解析 -#### 参考文档 +### 终端模拟 +- Termux: terminal-emulator 0.118.0 +- Termux: terminal-view 0.118.0 +- Termux: termux-shared 0.118.0 + +### 功能组件 +- ZXing 3.4.1 - 二维码生成与扫描 +- JSch 0.1.55 - SSH/SFTP 客户端 +- Jsoup 1.13.1 - HTML 解析 +- FastJSON 1.2.76 - JSON 处理 + +### UI 组件 +- Material Design 1.4.0 +- AndroidX 组件库 +- PullRefreshLayout 1.2.0 - 下拉刷新 + +## Gradle 编译说明 + +### 调试版编译 +```bash +gradle assembleDebug +``` + +### 阶段版编译(发布) +```bash +bash .winboll/bashPublishAPKAddTag.sh gpsrelaysentinel +``` + +### 版本管理 +版本信息由 `gpsrelaysentinel/build.properties` 管理: +- `baseVersion` - 基础版本号 +- `stageCount` - 阶段构建次数 +- `publishVersion` - 发布版本号 +- `buildCount` - 构建次数 + +## 使用说明 + +### Termux 应用配置 + +1. 安装 Termux 应用(包名: `com.termux`) +2. 配置允许外部应用访问: + ```bash + echo "allow-external-apps = true" > ~/.termux/termux.properties + ``` + +### 权限说明 + +应用需要以下权限: +- 网络访问权限 +- 存储读写权限 +- 相机权限(二维码扫描) +- 位置权限(GPS 相关功能) + +## 项目结构 + +``` +gpsrelaysentinel/ +├── src/main/ +│ ├── java/ # Java 源码(Java 7 语法) +│ ├── res/ # 资源文件 +│ ├── libs/ # 本地库文件(含 JNI 库) +│ └── AndroidManifest.xml +├── build.gradle # 模块构建配置 +└── build.properties # 版本配置文件 +``` + +## 参与贡献 + +1. Fork 本仓库 +2. 新建功能分支 (`git checkout -b feat_xxx`) +3. 提交代码(作者: ZhanGSKen ) +4. 新建 Pull Request + +## 许可证 + +[待添加许可证信息] + +## 参考文档 + +- [Android Developer Documentation](https://developer.android.com/) +- [Termux Wiki](https://wiki.termux.com/) +- [Gradle User Manual](https://docs.gradle.org/)