update docs

2024-11-29 18:48:09 +08:00 · 2019-04-24 09:17:52 +08:00 · 2019-04-24 09:17:52 +08:00 · dc68a92ef8
commit dc68a92ef8
parent 4eef258af1
3 changed files with 145 additions and 62 deletions
--- a/README.md
+++ b/README.md
@ -1,58 +1,131 @@

-
-![zlg](docs/images/zlg_adv.jpeg)
-
 # AWTK = Toolkit AnyWhere

-最终目标：
+![zlg](docs/images/zlg_adv.jpeg)

-* 支持开发嵌入式软件。
+## 一、介绍
+
+[AWTK](https://github.com/zlgopen/awtk)全称Toolkit AnyWhere，是[ZLG](http://www.zlg.cn/)开发的开源GUI引擎，旨在为嵌入式系统、WEB、各种小程序、手机和PC打造的通用GUI引擎，为用户提供一个功能强大、高效可靠、简单易用、可轻松做出炫酷效果的GUI引擎。
+
+[AWTK](https://github.com/zlgopen/awtk)寓意有两个方面：
+
+* Toolkit AnyWhere。 
+* ZLG物联网操作系统AWorks内置GUI。
+
+[AWTK](https://github.com/zlgopen/awtk)源码仓库：
+
+* 主源码仓库：[https://github.com/zlgopen/awtk](https://github.com/zlgopen/awtk)
+* 镜像源码仓库：[https://gitee.com/zlgopen/awtk](https://gitee.com/zlgopen/awtk)
+
+## 二、最终目标：
+
+* 支持开发嵌入式应用程序。
 * 支持开发Linux应用程序。
 * 支持开发MacOS应用程序。
 * 支持开发Windows应用程序。
+* 支持开发Web APP。
+* 支持开发微信小程序。
+* 支持开发支付宝小程序。
+* 支持开发百度小程序。
 * 支持开发Android应用程序。
 * 支持开发iOS应用程序。
-* 支持开发2D游戏。
+* 支持开发2D小游戏。

-其主要特色有：
+## 三、主要特色

-1. 小巧。在精简配置下，不依赖第三方软件包，仅需要32K RAM + 256K FLASH即可开发一些简单的图形应用程序。
+### 1.跨平台

-2. 高效。采用脏矩形裁剪算法，每次只绘制和更新变化的部分，极大提高运行效率和能源利用率。
+[AWTK](https://github.com/zlgopen/awtk)是跨平台的，这有两个方面的意思：

-3. 稳定。通过良好的架构设计和编程风格、单元测试、动态(valgrind)检查和Code Review保证其运行的稳定性。
+* AWTK本身是跨平台的。目前支持的平台有ZLG AWorks、Windows、Linux、MacOS、嵌入式Linux和嵌入式裸系统，可以轻松的移植到各种RTOS上。AWTK以后也可以运行在浏览器(即将公测)、各种小程序、Android和iOS等平台上运行。

-4. 丰富的GUI组件。提供窗口、对话框和各种常用的组件(用户可以配置自己需要的组件，降低对运行环境的要求)。
+* AWTK同时还提供了一套跨平台的基础工具库。其中包括链表、数组、字符串(UTF8和widechar)，事件发射器、值、对象、文件系统、互斥所和线程、表达式和字符串解析等等，让你用AWTK开发的应用程序可以真正跨平台运行。

-5. 支持多种字体格式。内置位图字体(并提供转换工具)，也可以使用stb\_truetype或freetype加载ttf字体。
+### 2.高效

-6. 支持多种图片格式。内置位图图片(并提供转换工具)，也可以使用stb\_image加载png/jpg等格式的图片。
+[AWTK](https://github.com/zlgopen/awtk)通过一系列的手段保证AWTK应用程序高效运行：

-7. 紧凑的二进制界面描述格式。可以手工编辑的XML格式的界面描述文件，也可以使用Qt Designer设计界面，然后转换成紧凑的二进制界面描述格式，提高运行效率，减小内存开销。
+* 通过脏矩算法只更新变化的部分。
+* 支持3 FrameBuffer让界面以最高帧率运行(可选)。
+* UI描述文件和主题文件使用高效的二进制格式，解析在瞬间完成。
+* 支持各种GPU加速接口。如OpenGL、DirectX、Vulman和Metal等。
+* 支持嵌入式平台的各种2D加速接口。目前STM32的DMA2D和NXP的PXP接口，厂家可以轻松扩展自己的加速接口。

-8. 支持主题并采用紧凑的二进制格式。开发时使用XML格式描述主题，然后转换成紧凑的二进制格式，提高运行效率，减小内存开销。
+### 3.稳定

-9. 支持裸系统，无需OS和文件系统。字体、图片、主题和界面描述数据都编译到代码中，以常量数据的形式存放，运行时无需加载到内存。
+[AWTK](https://github.com/zlgopen/awtk)通过下列方式极力让代码稳定可靠：

-10. 内置nanovg实现高质量的矢量动画，并支持SVG矢量图。
+* 使用cppcheck和facebook infer进行静态检查。
+* 使用valgrind进行动态内存检查。
+* 近两万行的单元测试代码。
+* ZLG强大GUI团队的支持。
+* 经过多个实际项目验证。
+* 多平台/多编译器验证。
+* 优秀的架构设计。
+* Code Review。
+* 手工测试。

-11. 支持窗口动画、控件动画、滑动动画和高清LCD等现代GUI常见特性。
+### 4.强大

-12. 支持国际化(Unicode、字符串翻译和输入法等)。
+* 丰富的控件(持续增加中)。
+* 支持各种图片格式(png/jpg/gif/svg)。
+* 支持各种字体格式(点阵和矢量)。
+* 支持窗口动画
+* 支持控件动画
+* 支持高清屏。
+* 支持界面描述文件。
+* 支持主题描述文件。
+* 支持控件布局策略。
+* 支持对话框高亮策略。
+* 丰富的辅助工具。
+* 支持从低端的Cortex M3到各种高端CPU。
+* 支持无文件系统和自定义的文件系统。
+* 支持裸系统和RTOS。

-13. 可移植。支持移植到各种RTOS和嵌入式Linux系统，并通过SDL在各种流行的PC/手机系统上运行。
+### 5.易用

-14. 脚本化。从API注释中提取API的描述信息，通过这些信息可以自动生成各种脚本的绑定代码。
+* 大量的示例代码。
+* 完善的API文档和使用文档。
+* ZLG 强大的技术支持团队。
+* 用AWTK本身开发的界面编辑器(开发中)。
+* 声明式的界面描述语言。一行代码启用控件动画，启用窗口动画，显示图片(png/jpg/svg/gif)。

-15. 支持硬件2D加速(目前支持STM32的DMA2D和NXP的PXP)和GPU加速(OpenGL/OpenGLES/DirectX/Metal)，充分挖掘硬件潜能。
+### 6.高度扩展性

-16. 丰富的文档和示例代码。
+* 可以扩展自己的控件。
+* 可以扩展自己的动画。
+* 可以实现自己的主循环。
+* 可以扩展自己的软键盘。
+* 可以扩展自己的图片加载器。
+* 可以扩展自己的字体加载器。
+* 可以扩展自己的输入法引擎。
+* 可以扩展自己的控件布局算法。
+* 可以扩展自己的对话框高亮策略。
+* 可以实现自己的LCD接口。
+* 可以扩展自己的矢量引擎(如使用skia/cairo)。
+* 所有扩展组件和内置组件具有相同的待遇。

-17. 采用LGPL协议开源发布，在商业软件中使用时无需付费。

-目前核心功能已经完成，内部开始在实际项目中使用了，欢迎有兴趣的朋友评估和尝试，期待您的反馈。
+### 7.多种开发语言

-## 模拟运行：
+[AWTK](https://github.com/zlgopen/awtk)本身是用C语言开发的，可以通过IDL生成各种脚本语言的绑定。生成的绑定代码不是简单的把C语言的API映射到脚本语言，而是生成脚本语言原生代码风格的API。目前支持以下语言(以后根据需要增加)：
+
+* C
+* Lua
+* Javascript on jerryscript
+* Javascript on nodejs
+
+### 8.国际化
+
+* 支持Unicode。
+* 支持输入法。
+* 支持字符串翻译(实时生效)。
+* 支持图片翻译(实时生效)。
+* 文字双向排版(计划中)。
+
+### 9.开放源码，免费商用(LGPL)。
+
+## 四、模拟运行：

 ### Mac

@ -86,7 +159,7 @@ scons

 ### Windows

-(请先安装python2.7，scons和Visual Studio C++(版本>=2017)
+(请先安装python，scons和Visual Studio C++(版本>=2017)

 编译运行(在命令行模式下，进入awtk所在的目录，并运行下列命令)：

@ -95,11 +168,13 @@ scons
 bin\demoui
 ```

-## 演示视频
+## 五、在线演示

-1.[基本控件演示](https://v.qq.com/txp/iframe/player.html?vid=n07811pocfx)
+* [基本控件在线演示](http://zlgopen.bceapp.com/awtk/demos/demoui/index.html)

-## 各个平台的移植
+> 目前AWTK-WEB还处于测试阶段，部分功能不能正常工作。如有兴趣请在PC上自行编译运行。
+
+## 六、各个平台的移植

 #### 官方支持平台 

@ -117,29 +192,33 @@ bin\demoui

 * [linux-framebuffer(嵌入式Linux请用本项目)](https://github.com/zlgopen/awtk-linux-fb)

-## 各语言的绑定
+## 七、各语言的绑定

 * [awtk-lua](https://github.com/zlgopen/awtk-lua)

 * [awtk-js](https://github.com/zlgopen/awtk-js)

-## 相关工程
+## 八、相关工程

 * [模板工程](https://github.com/zlgopen/awtk-hello)

 * [C示例代码](https://github.com/zlgopen/awtk-c-demos)

+* [AWTK-WEB](https://github.com/zlgopen/awtk-web)
+
+* [AWTK-MVVM](https://github.com/zlgopen/awtk-mvvm)
+
 * [扩展控件实例: 二维码](https://github.com/CUITzhaoqi/awtk-qr)

-## 文档
+## 九、文档

 [文档](docs/README.md)

-## 任务完成情况
+## 十、任务完成情况

 [任务完成情况](TODO.md)

-## 最新动态
+## 十一、最新动态

 [最新动态](docs/changes.md)

--- a/docs/changes.md
+++ b/docs/changes.md
@ -1,6 +1,7 @@
 # 最新动态
 * 2019/04/24
  * 修改AGGE模式支持APP\_DESKTOP的问题(感谢尧燊提供补丁)
+  * 更新文档。

 * 2019/04/23
  * 修改编译脚本支持python3。建议大家都使用python3，python2很快不被官方支持了。
--- a/docs/release_notes/awtk-1.1.md
+++ b/docs/release_notes/awtk-1.1.md
@ -1,21 +1,22 @@

 ## ZLG AWTK 1.1 Release Notes

-### 一、介绍
+## 一、介绍

-AWTK全称Toolkit AnyWhere，是[ZLG](http://www.zlg.cn/)开发的开源GUI引擎，旨在为嵌入式系统、WEB、各种小程序、手机和PC打造的通用GUI引擎，为用户提供一个功能强大、高效可靠、简单易用、可轻松做出炫酷效果的GUI引擎。
+[AWTK](https://github.com/zlgopen/awtk)全称Toolkit AnyWhere，是[ZLG](http://www.zlg.cn/)开发的开源GUI引擎，旨在为嵌入式系统、WEB、各种小程序、手机和PC打造的通用GUI引擎，为用户提供一个功能强大、高效可靠、简单易用、可轻松做出炫酷效果的GUI引擎。

-AWTK寓意有两个方面：
+[AWTK](https://github.com/zlgopen/awtk)寓意有两个方面：

 * Toolkit AnyWhere。 
 * ZLG物联网操作系统AWorks内置GUI。

-AWTK源码仓库：
+[AWTK](https://github.com/zlgopen/awtk)源码仓库：

 * 主源码仓库：[https://github.com/zlgopen/awtk](https://github.com/zlgopen/awtk)
 * 镜像源码仓库：[https://gitee.com/zlgopen/awtk](https://gitee.com/zlgopen/awtk)

-### 二、最终目标：
+## 二、最终目标：
+
 * 支持开发嵌入式应用程序。
 * 支持开发Linux应用程序。
 * 支持开发MacOS应用程序。
@ -28,19 +29,19 @@ AWTK源码仓库：
 * 支持开发iOS应用程序。
 * 支持开发2D小游戏。

-### 三、主要特色
+## 三、主要特色

-#### 1.跨平台
+### 1.跨平台

-AWTK是跨平台的，这有两个方面的意思：
+[AWTK](https://github.com/zlgopen/awtk)是跨平台的，这有两个方面的意思：

 * AWTK本身是跨平台的。目前支持的平台有ZLG AWorks、Windows、Linux、MacOS、嵌入式Linux和嵌入式裸系统，可以轻松的移植到各种RTOS上。AWTK以后也可以运行在浏览器(即将公测)、各种小程序、Android和iOS等平台上运行。

 * AWTK同时还提供了一套跨平台的基础工具库。其中包括链表、数组、字符串(UTF8和widechar)，事件发射器、值、对象、文件系统、互斥所和线程、表达式和字符串解析等等，让你用AWTK开发的应用程序可以真正跨平台运行。

-#### 2.高效
+### 2.高效

-ATWTK通过一系列的手段保证AWTK应用程序高效运行：
+[AWTK](https://github.com/zlgopen/awtk)通过一系列的手段保证AWTK应用程序高效运行：

 * 通过脏矩算法只更新变化的部分。
 * 支持3 FrameBuffer让界面以最高帧率运行(可选)。
@ -48,9 +49,9 @@ ATWTK通过一系列的手段保证AWTK应用程序高效运行：
 * 支持各种GPU加速接口。如OpenGL、DirectX、Vulman和Metal等。
 * 支持嵌入式平台的各种2D加速接口。目前STM32的DMA2D和NXP的PXP接口，厂家可以轻松扩展自己的加速接口。

-#### 3.稳定
+### 3.稳定

-AWTK通过下列方式极力让代码稳定可靠：
+[AWTK](https://github.com/zlgopen/awtk)通过下列方式极力让代码稳定可靠：

 * 使用cppcheck和facebook infer进行静态检查。
 * 使用valgrind进行动态内存检查。
@ -62,7 +63,7 @@ AWTK通过下列方式极力让代码稳定可靠：
 * Code Review。
 * 手工测试。

-#### 4.强大
+### 4.强大

 * 丰富的控件(持续增加中)。
 * 支持各种图片格式(png/jpg/gif/svg)。
@ -79,7 +80,7 @@ AWTK通过下列方式极力让代码稳定可靠：
 * 支持无文件系统和自定义的文件系统。
 * 支持裸系统和RTOS。

-#### 5.易用
+### 5.易用

 * 大量的示例代码。
 * 完善的API文档和使用文档。
@ -87,7 +88,7 @@ AWTK通过下列方式极力让代码稳定可靠：
 * 用AWTK本身开发的界面编辑器(开发中)。
 * 声明式的界面描述语言。一行代码启用控件动画，启用窗口动画，显示图片(png/jpg/svg/gif)。

-#### 6.高度扩展性
+### 6.高度扩展性

 * 可以扩展自己的控件。
 * 可以扩展自己的动画。
@ -103,16 +104,16 @@ AWTK通过下列方式极力让代码稳定可靠：
 * 所有扩展组件和内置组件具有相同的待遇。


-#### 7.多种开发语言
+### 7.多种开发语言

-AWTK本身是用C语言开发的，可以通过IDL生成各种脚本语言的绑定。生成的绑定代码不是简单的把C语言的API映射到脚本语言，而是生成脚本语言原生代码风格的API。目前支持以下语言(以后根据需要增加)：
+[AWTK](https://github.com/zlgopen/awtk)本身是用C语言开发的，可以通过IDL生成各种脚本语言的绑定。生成的绑定代码不是简单的把C语言的API映射到脚本语言，而是生成脚本语言原生代码风格的API。目前支持以下语言(以后根据需要增加)：

 * C
 * Lua
 * Javascript on jerryscript
 * Javascript on nodejs

-#### 8.国际化
+### 8.国际化

 * 支持Unicode。
 * 支持输入法。
@ -120,11 +121,12 @@ AWTK本身是用C语言开发的，可以通过IDL生成各种脚本语言的绑
 * 支持图片翻译(实时生效)。
 * 文字双向排版(计划中)。

-#### 9.开放源码，免费商用(LGPL)。
+### 9.开放源码，免费商用(LGPL)。

-### 四、1.1 版本更新
+## 四、1.1 版本更新
+-------------------

-#### 1.稳定性增强
+### 1.稳定性增强

 * 多个实际项目验证。
 * 新增数百个测试用例。
@ -133,14 +135,14 @@ AWTK本身是用C语言开发的，可以通过IDL生成各种脚本语言的绑
 * 使用cppcheck静态检查，并修改发现的问题。
 * 使用valgrind动态内存检查，并修改发现的问题。

-#### 2.优化性能
+### 2.优化性能

 * 绘制半透明色矩形速度提高3倍。
 * 缩放不透明图片快1倍(bgr565格式LCD)。
 * 缩放半透明图片快30%(bgr565格式LCD)。


-#### 3.新增特性
+### 3.新增特性

 * 窗口动画支持自定义。
 * 新增4种内置窗口动画。
@ -160,22 +162,23 @@ AWTK本身是用C语言开发的，可以通过IDL生成各种脚本语言的绑
 * UI XML文件支持简单表达式。
 * 改进编译脚本和资源生成脚本。

-#### 4.新增控件
+### 4.新增控件

 * 增加mutable image，用于实现camera和video时显示图像。

-#### 5.新增重要API
+### 5.新增重要API

 * window\_manager\_back 返回上一级窗口。
 * window\_manager\_back\_to\_home 返回主窗口。
 * window\_close\_force 强制关闭窗口(忽略动画)。
 * ui\_loader\_load\_widget 用于加载局部组件。

-#### 6.Bug修改和完善功能
+### 6.Bug修改和完善功能

 详情请参考[docs/changes.md](https://github.com/zlgopen/awtk/blob/master/docs/changes.md)。

-### 五、预告
+## 五、预告
+-------------------

 下一个版本计划推出下列功能：