更正项目说明书。
This commit is contained in:
95
README.md
95
README.md
@@ -4,26 +4,27 @@ WinBoLL 源生态计划项目说明书
|
||||
|
||||
1. 核心定位
|
||||
|
||||
【OriginMaster】WinBoLL 源生态计划，旨在通过核心项目 WinBoLL 联动系列开发库，构建手机端 Android 项目开发与多端编译同步的完整生态，实现手机与电脑的源码同步开发。
|
||||
WinBoLL 手机源码计划，旨在通过核心项目 WinBoLL 构建手机端与服务器端的 Android 项目的开发源码生态。实现手机与服务器的源码的联合开发。
|
||||
|
||||
2. 仓库架构
|
||||
|
||||
仓库类型 包含仓库 功能说明
|
||||
开发库 WinBoLL、APPBase、AES、PowerBell、Positions 核心开发依赖库，其中 WinBoLL 可作为应用开发的基础继承模板
|
||||
分支汇总存档库 OriginMaster 仅用于汇总各开发库分支，不适宜作为开发库克隆使用，非应用开发基础库
|
||||
仓库类型：功能说明
|
||||
基础项目分支 WinBoLL：手机端安卓应用开发基础模板。
|
||||
应用项目分支 APPBase、AES、PowerBell、Positions：安卓应用单一管理系列项目。
|
||||
各类分支源码合并存档 OriginMaster： 源码汇总管理，不适宜作为开发库使用。
|
||||
|
||||
3. 源码推送路径
|
||||
3. 源码合并管理推送路线图。（仅仅展示不同应用模块源码的综合管理路线。分支合并操作时，必须具备Git管理经验。）
|
||||
|
||||
- WinBoLL → APPBase → OriginMaster
|
||||
- WinBoLL → AES → OriginMaster
|
||||
- WinBoLL → PowerBell → OriginMaster
|
||||
- WinBoLL → Positions → OriginMaster
|
||||
|
||||
二、WinBoLL APP 核心信息
|
||||
二、WinBoLL 项目核心信息
|
||||
|
||||
1. 项目简介
|
||||
|
||||
WinBoLL Studio Android 应用开源项目，专注于手机端 Android 开发与多端编译同步。
|
||||
WinBoLL 项目是为手机端开发 Android 项目的需求而设计的项目。
|
||||
|
||||
2. 官方资源
|
||||
|
||||
@@ -32,73 +33,71 @@ WinBoLL Studio Android 应用开源项目，专注于手机端 Android 开发与
|
||||
- Gitea：https://gitea.winboll.cc/Studio/WinBoLL.git
|
||||
- GitHub：https://github.com/ZhanGSKen/WinBoLL.git
|
||||
- 码云：https://gitee.com/zhangsken/winboll.git
|
||||
- 托管类库源码：
|
||||
- APPBase（jitpack.io）：https://github.com/ZhanGSKen/APPBase.git
|
||||
- AES（jitpack.io）：https://github.com/ZhanGSKen/AES.git
|
||||
|
||||
三、通用特征文件夹前置（/sdcard）
|
||||
|
||||
- Linux 系统文件夹直接使用 /sdcard 。
|
||||
- 手机 SD 卡存储（ /storage/emulated/0 ）挂载的别名也可为 /sdcard 。
|
||||
- Linux 服务器端系统需要建立 /sdcard/WinBoLLStudio/APKs 目录。
|
||||
- 手机开发端需要建立 /storage/emulated/0/WinBoLLStudio/APKs 。
|
||||
|
||||
四、前置条件
|
||||
|
||||
1. WinBoLL-APP 配置
|
||||
1. WinBoLL APP 开发环境配置介绍
|
||||
|
||||
- APK 编译输出目录： /sdcard/WinBoLLStudio/APKs/ ，以及 /sdcard/AppProjects/ （命名为 app.apk ）
|
||||
- 签名与命名空间：支持应用签名验证定制化，与衍生 APP 共享 cc.winboll.studio 命名空间
|
||||
- WinBoLL APK 编译输出内容包括：
|
||||
"/sdcard/WinBoLLStudio/APKs" 目录内的所有应用分支的 APK 文件，
|
||||
与 "/sdcard/AppProjects/app.apk"文件。
|
||||
- WinBoLL APK 使用 "cc.winboll.studio" 命名空间。
|
||||
|
||||
五、核心需求规划
|
||||
|
||||
1. 主机端需求
|
||||
1. WinBoLL 应用安全验证需求
|
||||
|
||||
- 支持 https://console.winboll.cc/ 访问服务器以校验应用包签名与版本。
|
||||
|
||||
- 支持 winboll.cc 域名的用户注册登录服务
|
||||
- 支持 https://console.winboll.cc/api 访问
|
||||
2. 手机端源码开发管理需求
|
||||
|
||||
2. APP 端需求
|
||||
|
||||
- 实现手机端 Android 应用开发与管理功能
|
||||
- 支持切换不同 WinBoLL 分支，以开发不同安卓应用。
|
||||
|
||||
六、编译与使用指南
|
||||
|
||||
1. 项目初始化（必须）
|
||||
|
||||
1. 复制 settings.gradle-demo 为 settings.gradle ，取消对应项目模块注释
|
||||
2. 复制 gradle.properties-androidx-demo 或 gradle.properties-android-demo 为 gradle.properties
|
||||
3. （可选）复制 local.properties-demo 为 local.properties ，配置 Android SDK 目录
|
||||
1. 复制 settings.gradle-demo 为 settings.gradle 。编辑 settings.gradle 文件内容，取消对应项目模块注释。
|
||||
2. 复制 gradle.properties-androidx-demo(Android X 项目) 或 gradle.properties-android-demo(基本 Android 项目) 为 gradle.properties。
|
||||
3. 复制（可选）local.properties-demo 为 local.properties ，编辑 local.properties 文件内容，配置 Android SDK 目录。
|
||||
4. 签名设置：
|
||||
- 调试编译：进入 GenKeyStore 目录执行 bash gen_debug_keystore.sh
|
||||
- 非必须：clone keystore 模块，拷贝 appkey.jks 与 appkey.keystore 到项目根目录
|
||||
- 调试编译秘钥制作：使用 Termux 应用终端 cd 进入 GenKeyStore 目录，运行 bash gen_debug_keystore.sh 脚本即可生成应用调试秘钥。
|
||||
- 应用秘钥配置方法：拷贝调试编译秘钥制作生成的 appkey.jks 与 appkey.keystore 文件到项目根目录即可。
|
||||
|
||||
2. 编译命令
|
||||
七、应用编译命令介绍
|
||||
|
||||
（1）类库型项目
|
||||
（1）类库型模块配置要点
|
||||
|
||||
1. 修改测试项目 build.properties ，设置 libraryProject=<类库项目模块名>
|
||||
2. 编译测试项目： bash .winboll/bashPublishAPKAddTag.sh <应用项目模块名>
|
||||
3. 编译类库项目： bash .winboll/bashPublishLIBAddTag.sh <类库项目模块名> （发布至 WinBoLL Nexus Maven 库）
|
||||
1. 优先修改应用测试项目（目录为"<WinBoLl根目录>/<类库测试应用>/"）内 build.properties 文件，设置对应的类库项目名称：libraryProject=<类库项目模块名> 。
|
||||
2. 编译优先启动步骤：使用 Termux 应用，进入"<WinBoLl根目录>"，运行 $bash .winboll/bashPublishAPKAddTag.sh <类库测试项目模块名> 命令，运行后可生成测试项目与类库项目的编译参数文件 build.properties 。生成的 build.properties 文件有两份，一份在测试项目模块的文件夹内，一份在类库项目本身的模块文件夹内。
|
||||
3. 类库编译发布步骤：使用 Termux 应用，进入"<WinBoLl根目录>"，运行 $bash .winboll/bashPublishLIBAddTag.sh <类库项目模块名> 命令，运行后可发布至 WinBoLL Nexus Maven 库、本地maven目录或者是通用默认的 Gradle Maven 库。
|
||||
|
||||
（2）应用型项目
|
||||
（2）单一应用型模块与类库测试型模块配置要点
|
||||
|
||||
- 编译命令： bash .winboll/bashPublishAPKAddTag.sh <应用项目模块名>
|
||||
- 编译方法：使用 Termux 应用，进入"<WinBoLl根目录>"，运行 $bash .winboll/bashPublishAPKAddTag.sh <应用项目模块名> ，运行后
|
||||
- 编译输出路径：
|
||||
默认路径(assembleBetaDebug任务)： /sdcard/WinBoLLStudio/APKs/<项目根目录名称>/debug/
|
||||
默认路径(assembleStageRelease任务)： /sdcard/WinBoLLStudio/APKs/<项目根目录名称>/tag/
|
||||
额外路径：若 winboll.properties 配置 ExtraAPKOutputPath ，APK 同步拷贝至该ExtraAPKOutputPath路径
|
||||
|
||||
（3）调试编译
|
||||
（3）手机端应用调试命令介绍
|
||||
|
||||
- Beta 调试： bash gradlew assembleBetaDebug
|
||||
- Stage 调试： bash gradlew assembleStageDebug
|
||||
- Beta 渠道调试命令：$bash gradlew assembleBetaDebug
|
||||
- Stage 渠道调试命令：$bash gradlew assembleStageDebug
|
||||
|
||||
（4）发布编译
|
||||
|
||||
- Stage 发布：bash .winboll/bashPublishAPKAddTag.sh <应用项目模块名>
|
||||
或者执行 bash gradlew assembleStageRelease
|
||||
|
||||
3. 编译输出路径
|
||||
|
||||
- 默认路径(assembleBetaDebug任务)： /sdcard/WinBoLLStudio/APKs/<项目根目录名称>/debug/
|
||||
- 默认路径(assembleStageRelease任务)： /sdcard/WinBoLLStudio/APKs/<项目根目录名称>/tag/
|
||||
- 额外路径：若 winboll.properties 配置 ExtraAPKOutputPath ，APK 同步拷贝至该ExtraAPKOutputPath路径
|
||||
|
||||
4. 版本号命名规则
|
||||
（4）服务器端应用发布命令介绍
|
||||
|
||||
- Stage 渠道应用发布命令为（"<WinBoLl根目录>/settings.gradle"文件需要配置编译模块开启参数，拷贝 settings.gradle-demo 为 settings.gradle 文件取消对应的分支配置部分即可。）：
|
||||
$bash .winboll/bashPublishAPKAddTag.sh <应用项目模块名>
|
||||
或者
|
||||
$bash gradlew assembleStageRelease
|
||||
|
||||
|
||||
八、WinBoLL 应用 APK 版本号命名规则
|
||||
- Stage 渠道： V<应用开发环境编号><应用功能变更号><应用调试阶段号> （示例： APPBase_15.7.0 ）
|
||||
- Beta 渠道： V<应用开发环境编号><应用功能变更号><应用调试阶段号>-beta<调试编译计数>_<调试编译时间(分钟+秒钟)> （示例： APPBase_15.9.6-beta8_5413 ）
|
||||
|
||||
Reference in New Issue
Block a user