From f6e5f3fc5d4cb2234cc20b3f53a0a5a60a06cd92 Mon Sep 17 00:00:00 2001 From: sunjie Date: Tue, 14 Jan 2025 20:21:51 +0800 Subject: [PATCH 1/2] =?UTF-8?q?=E4=BF=AE=E6=94=B9restool=20README.md?= =?UTF-8?q?=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: sunjie Change-Id: I376ed49f61771ed1dffcc3aa2f802c587f3dcfba Signed-off-by: sunjie --- README_zh.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README_zh.md b/README_zh.md index a05b73a..36d6296 100644 --- a/README_zh.md +++ b/README_zh.md @@ -25,7 +25,7 @@ restool（资源编译工具）是一种资源构建工具。通过编译资源 ### 参数说明 -restool当前支持以下命令选项: +#### restool当前支持以下命令选项: | 选项 | 是否可缺省 | 是否存在入参 | 描述 | | -------- | -------- | -------- | -------- | @@ -46,7 +46,7 @@ restool当前支持以下命令选项: | --defined-ids | 可缺省 | 带参数 | 指定id_defined.json文件路径，一般都是通过--ids生成。
id_defined.json包含资源类型、名称及其ID的列表。
开发者可以自定义id_defined.json中的资源ID。 | | --dependEntry | 可缺省 | 带参数 | FA模型下单独编译feature时，指定entry模块的编译结果目录。 | | --icon-check | 可缺省 | 不带参数 | 开启icon和startWindowIcon的PNG图片校验功能。 | -| --target-config | 可缺省 | 带参数 | 与“-i”命令同时使用，支持选择编译。
[参数说明](#target-config参数说明)：指定要包含的配置。| +| --target-config | 可缺省 | 带参数 | 与“-i”命令同时使用，支持选择编译。
具体可参考如下[参数说明](#target-config参数说明)| #### target-config参数说明 @@ -66,6 +66,34 @@ Locale匹配规则：Locale匹配需满足以下三条规则。 参数举例说明：Locale[zh_CN,en_US];Device[phone]，该参数过滤其他语言，保留能匹配上zh_CN和en_US的语言；过滤其他设备，保留phone；其他参数（如MccMnc、Orientation等）配置不过滤均保留。 + +#### restool当前支持以下子命令： + +| 命令 | 描述 | +| --- | ---- | +| dump | 以json的格式输出hap包中resource的内容 | + +**dump命令** + +``` +restool dump [-h] [config] filePath +``` +dump命令参数列表 + +| 参数 | 是否可缺省 | 是否存在入参 | 参数说明 | +| --- | --------- | ---------- |------- | +| -h | 可缺省 | 不带参数 | 帮助信息 | +| config | 可缺省 | 不带参数 | 只打印hap包中资源的限定词信息 | + +示例: + +```sh +# 打印hap包中所有的资源信息 +restool dump entry.hap +# 打印hap包中资源的限定词信息 +restool dump config entry.hap +``` + ### 使用实例 例如：entry目录结构如下 From 6463921c3d4211aa33aedc9048bc29d041515a9d Mon Sep 17 00:00:00 2001 From: sunjie Date: Wed, 22 Jan 2025 01:20:21 +0000 Subject: [PATCH 2/2] update README_zh.md. Signed-off-by: sunjie --- README_zh.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README_zh.md b/README_zh.md index 36d6296..6ad903b 100644 --- a/README_zh.md +++ b/README_zh.md @@ -25,7 +25,7 @@ restool（资源编译工具）是一种资源构建工具。通过编译资源 ### 参数说明 -#### restool当前支持以下命令选项: +#### restool支持的命令选项 | 选项 | 是否可缺省 | 是否存在入参 | 描述 | | -------- | -------- | -------- | -------- | @@ -46,9 +46,9 @@ restool（资源编译工具）是一种资源构建工具。通过编译资源 | --defined-ids | 可缺省 | 带参数 | 指定id_defined.json文件路径，一般都是通过--ids生成。
id_defined.json包含资源类型、名称及其ID的列表。
开发者可以自定义id_defined.json中的资源ID。 | | --dependEntry | 可缺省 | 带参数 | FA模型下单独编译feature时，指定entry模块的编译结果目录。 | | --icon-check | 可缺省 | 不带参数 | 开启icon和startWindowIcon的PNG图片校验功能。 | -| --target-config | 可缺省 | 带参数 | 与“-i”命令同时使用，支持选择编译。
具体可参考如下[参数说明](#target-config参数说明)| +| --target-config | 可缺省 | 带参数 | 与“-i”命令同时使用，支持选择编译。
具体可参考如下**target-config参数说明**。| -#### target-config参数说明 +**target-config参数说明** 支持参数配置类型：MccMnc、Locale、Orientation、Device、ColorMode、Density @@ -67,11 +67,11 @@ Locale匹配规则：Locale匹配需满足以下三条规则。 参数举例说明：Locale[zh_CN,en_US];Device[phone]，该参数过滤其他语言，保留能匹配上zh_CN和en_US的语言；过滤其他设备，保留phone；其他参数（如MccMnc、Orientation等）配置不过滤均保留。 -#### restool当前支持以下子命令： +#### restool支持的子命令 | 命令 | 描述 | | --- | ---- | -| dump | 以json的格式输出hap包中resource的内容 | +| dump | 以json的格式输出hap包中resource的内容。 | **dump命令** @@ -80,10 +80,10 @@ restool dump [-h] [config] filePath ``` dump命令参数列表 -| 参数 | 是否可缺省 | 是否存在入参 | 参数说明 | +| 参数 | 是否可缺省 | 是否存在入参 | 描述 | | --- | --------- | ---------- |------- | -| -h | 可缺省 | 不带参数 | 帮助信息 | -| config | 可缺省 | 不带参数 | 只打印hap包中资源的限定词信息 | +| -h | 可缺省 | 不带参数 | 帮助信息。 | +| config | 可缺省 | 不带参数 | 只打印hap包中资源的限定词信息。 | 示例: