improve build_config docs

This commit is contained in:
lixianjing 2024-11-03 16:22:48 +08:00
parent e54371badd
commit c9d33077be
2 changed files with 41 additions and 37 deletions

View File

@ -6,12 +6,7 @@
"app_name": "org.zlgopen.demoui", "app_name": "org.zlgopen.demoui",
"author": "xianjimli@hotmail.com", "author": "xianjimli@hotmail.com",
"copyright": "Guangzhou ZHIYUAN Electronics Co.,Ltd.", "copyright": "Guangzhou ZHIYUAN Electronics Co.,Ltd.",
"icon": "design/default/images/xx/awtk_icon.png",
"themes":["default", "dark"], "themes":["default", "dark"],
"title": {
"en_US": "DemoUI",
"zh_CN": "控件演示"
},
"sources": [ "sources": [
"demos/assets.c", "demos/assets.c",
"demos/vg_common.inc", "demos/vg_common.inc",
@ -29,6 +24,11 @@
} }
}, },
"harmonyos": { "harmonyos": {
"icon": "design/default/images/xx/awtk_icon.png",
"title": {
"en_US": "DemoUI",
"zh_CN": "控件演示"
},
"sources": [ "sources": [
] ]
}, },

View File

@ -9,18 +9,9 @@
* name 应用程序名称(不支持中文和特殊符号)。 * name 应用程序名称(不支持中文和特殊符号)。
* vendor 开发商。 * vendor 开发商。
* version 版本号。 * version 版本号。
* icon 图标。
* assets 资源所在的目录相对于配置文件所在的目录android/ios 一般使用"res/assets", web 一般使用 design * assets 资源所在的目录相对于配置文件所在的目录android/ios 一般使用"res/assets", web 一般使用 design
* sources 源文件列表(相对于配置文件所在的目录)。文件名支持通配符如*.c。只要添加应用程序本身和使用的第三方库的源码即可AWTK 本身用到的代码会自动添加。 * sources 源文件列表(相对于配置文件所在的目录)。文件名支持通配符如*.c。只要添加应用程序本身和使用的第三方库的源码即可AWTK 本身用到的代码会自动添加。
* includes 头文件搜索路径列表(相对于配置文件所在的目录)。 * includes 头文件搜索路径列表(相对于配置文件所在的目录)。
* title 标题,下面包含不同语言的翻译。
```
"title": {
"en_US": "DemoUI",
"zh_CN": "控件演示"
},
```
> sources 虽然是通用选项,但是不同平台,包含的源文件可能并不相同,此时应该放到具体平台之下,如果两者都有,则对其进行合并。 > sources 虽然是通用选项,但是不同平台,包含的源文件可能并不相同,此时应该放到具体平台之下,如果两者都有,则对其进行合并。
@ -129,7 +120,21 @@ android 平台选项放在 android 子键下面,目前支持以下选项:
} }
``` ```
## 五、完整示例 ## 五、harmonyos 平台选项
harmonyos 平台选项放在 harmonyos 子键下面。
* icon 图标。
* title 标题,下面包含不同语言的翻译。
```
"title": {
"en_US": "DemoUI",
"zh_CN": "控件演示"
},
```
## 六、完整示例
下面是 demoui 的完整示例 下面是 demoui 的完整示例
@ -138,48 +143,47 @@ android 平台选项放在 android 子键下面,目前支持以下选项:
"name": "demoui", "name": "demoui",
"version": "1.0", "version": "1.0",
"assets": "res/assets", "assets": "res/assets",
"vendor": "zlgopen",
"app_name": "org.zlgopen.demoui",
"author": "xianjimli@hotmail.com", "author": "xianjimli@hotmail.com",
"copyright": "Guangzhou ZHIYUAN Electronics Co.,Ltd.", "copyright": "Guangzhou ZHIYUAN Electronics Co.,Ltd.",
"themes":["default", "dark"],
"sources": [
"demos/assets.c",
"demos/vg_common.inc",
"demos/demo_ui_app.c",
"res/assets.inc",
"res/assets/__assets_dark.inc",
"res/assets/__assets_default.inc"
],
"web": { "web": {
"app_type": "c", "app_type": "c",
"assets": "design", "assets": "design",
"sources": [
"demos/assets.c",
"demos/demo_ui_app.c"
],
"config": { "config": {
"fontScale": "0.8", "fontScale": "0.8",
"defaultFont": "sans" "defaultFont": "sans"
} }
}, },
"android": { "harmonyos": {
"app_name": "org.zlgopen.demoui", "icon": "design/default/images/xx/awtk_icon.png",
"title": {
"en_US": "DemoUI",
"zh_CN": "控件演示"
},
"sources": [
]
},
"android": {
"sources": [ "sources": [
"demos/assets.c",
"demos/demo_ui_app.c",
"demos/vg_common.inc",
"res/assets.inc",
"res/assets/__assets_default.inc"
] ]
}, },
"ios": { "ios": {
"app_name": "org.zlgopen.demoui",
"sources": [ "sources": [
"demos/assets.c",
"demos/demo_ui_app.c",
"demos/vg_common.inc",
"res/assets.inc",
"res/assets/__assets_default.inc"
] ]
} }
} }
``` ```
## 六、harmonyos 平台选项
harmonyos 平台选项放在 harmonyos 子键下面
## 七、export.json 的用法 ## 七、export.json 的用法
> 为了方便引用自定义控件,自定义控件(包括无界面的库)需要提供一个 export.json 的配置文件,用于声明对外提供的源文件和编译参数。 > 为了方便引用自定义控件,自定义控件(包括无界面的库)需要提供一个 export.json 的配置文件,用于声明对外提供的源文件和编译参数。