docs: comprehensive documentation updates and modernization
- Update BUILDING.md with current build system information - Modernize various README files across the project - Update CHANGELOG.md with recent changes - Improve documentation consistency and formatting - Update platform-specific documentation (iOS, Electron, Docker) - Enhance test documentation and build guides
This commit is contained in:
@@ -40,7 +40,7 @@
|
||||
```shell
|
||||
sh install.sh <project_path>
|
||||
```
|
||||
|
||||
|
||||
- 如果是 Flutter 项目,`project_path`应为 Flutter 项目中的`ios/macos`目录路径。
|
||||
- 重复运行安装命令时,工具会先移除现有安装(如果有)。若需修改命令行选项,只需重新运行安装命令,无需先卸载。
|
||||
|
||||
@@ -150,6 +150,7 @@ sh clean.sh
|
||||
### 模板类型
|
||||
|
||||
模板分为以下几类:
|
||||
|
||||
- **AppTemplate.xcprivacy**:App 的隐私清单模板。
|
||||
- **FrameworkTemplate.xcprivacy**:通用的 Framework 隐私清单模板。
|
||||
- **FrameworkName.xcprivacy**:特定的 Framework 隐私清单模板,仅在`Templates/UserTemplates`目录有效。
|
||||
@@ -157,20 +158,24 @@ sh clean.sh
|
||||
### 模板优先级
|
||||
|
||||
对于 App,隐私清单模板的优先级如下:
|
||||
|
||||
- `Templates/UserTemplates/AppTemplate.xcprivacy` > `Templates/AppTemplate.xcprivacy`
|
||||
|
||||
对于特定的 Framework,隐私清单模板的优先级如下:
|
||||
|
||||
- `Templates/UserTemplates/FrameworkName.xcprivacy` > `Templates/UserTemplates/FrameworkTemplate.xcprivacy` > `Templates/FrameworkTemplate.xcprivacy`
|
||||
|
||||
### 默认模板
|
||||
|
||||
默认模板位于`Templates`根目录,目前包括以下模板:
|
||||
|
||||
- `Templates/AppTemplate.xcprivacy`
|
||||
- `Templates/FrameworkTemplate.xcprivacy`
|
||||
|
||||
这些模板将根据 API 使用分析结果进行修改,特别是`NSPrivacyAccessedAPIType`条目将被调整,以生成新的隐私清单用于修复,确保符合 App Store 要求。
|
||||
|
||||
**如果需要调整隐私清单模板,例如以下场景,请避免直接修改默认模板,而是使用自定义模板。如果存在相同名称的自定义模板,它将优先于默认模板用于修复。**
|
||||
|
||||
- 由于 API 使用分析结果不准确,生成了不合规的隐私清单。
|
||||
- 需要修改模板中声明的理由。
|
||||
- 需要声明收集的数据。
|
||||
@@ -198,6 +203,7 @@ sh clean.sh
|
||||
### 自定义模板
|
||||
|
||||
要创建自定义模板,请将其放在`Templates/UserTemplates`目录,结构如下:
|
||||
|
||||
- `Templates/UserTemplates/AppTemplate.xcprivacy`
|
||||
- `Templates/UserTemplates/FrameworkTemplate.xcprivacy`
|
||||
- `Templates/UserTemplates/FrameworkName.xcprivacy`
|
||||
@@ -205,6 +211,7 @@ sh clean.sh
|
||||
在这些模板中,只有`FrameworkTemplate.xcprivacy`会根据 API 使用分析结果对`NSPrivacyAccessedAPIType`条目进行调整,以生成新的隐私清单用于 Framework 修复。其他模板保持不变,将直接用于修复。
|
||||
|
||||
**重要说明:**
|
||||
|
||||
- 特定的 Framework 模板必须遵循命名规范`FrameworkName.xcprivacy`,其中`FrameworkName`需与 Framework 的名称匹配。例如`Flutter.framework`的模板应命名为`Flutter.xcprivacy`。
|
||||
- 对于 macOS Framework,应遵循命名规范`FrameworkName.Version.xcprivacy`,额外增加版本名称用于区分不同的版本。对于单一版本的 macOS Framework,`Version`通常为`A`。
|
||||
- SDK 的名称可能与 Framework 的名称不完全一致。要确定正确的 Framework 名称,请在构建项目后检查 App 包中的`Frameworks`目录。
|
||||
@@ -229,7 +236,7 @@ sh Report/report.sh <app_path> <report_output_path>
|
||||
|------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
|
||||
|  |  |
|
||||
|
||||
## 💡 重要考量
|
||||
## 💡 重要考量
|
||||
|
||||
- 如果最新版本的 SDK 支持隐私清单,请尽可能升级,以避免不必要的风险。
|
||||
- 此工具仅为临时解决方案,不应替代正确的 SDK 管理实践。
|
||||
|
||||
Reference in New Issue
Block a user