update doc

This commit is contained in:
idea4good 2019-08-20 10:09:50 +08:00
parent d556ff7c37
commit 4799d49959
3 changed files with 25 additions and 4 deletions

View File

@ -87,13 +87,12 @@ GuiLite is the smallest and simplest GUI library.
3. All rendering base on draw_pixel, no algorithm
4. Full documents and small live demos for reference
- [Design specification](doc/HowToWork.md)
- [How to build?](doc/HowToBuild.md)
- [How to build & port?](doc/HowToBuild.md)
- [How to Layout widgets?](doc/HowLayoutWork.md)
- [How to build unicode font/bitmap resource?](https://github.com/idea4good/GuiLiteToolkit)
- [How to switch theme?](https://github.com/idea4good/GuiLiteSamples/blob/master/HostMonitor/UIcode/source/resource/resource.cpp)
- [How to dispatch messages?](doc/HowMessageWork.md)
- [UML chart of GuiLite core](doc/UML.md)
- Extremly portable: Execute `1h-1cpp.sh` to merge the whole source code into: 1 header(GuiLite.h) & 1 source(GuiLite.cpp)
- How GuiLite multi-layers work?
- ![GuiLiteGraphic](doc/GuiLiteGraphic.gif)
- [Full video](https://www.youtube.com/watch?v=QzZJnU5KmDQ)

View File

@ -86,13 +86,12 @@ GuiLite是最简单易学的GUI库。
3. 图形绘制以描点为基础,不使用任何算法
4. 设计简单配有丰富的文档和实例程序遇到问题可以在QQ群获得帮助
- [软件设计说明](doc/HowToWork-cn.md)
- [如何编译?](doc/HowToBuild.md)
- [如何编译和移植?](doc/HowToBuild.md)
- [如何布局UI?](doc/HowLayoutWork.md)
- [如何制作多种文字/位图资源?](https://github.com/idea4good/GuiLiteToolkit)
- [如何“换肤”?](https://gitee.com/idea4good/GuiLiteSamples/blob/master/HostMonitor/UIcode/source/resource/resource.cpp)
- [如何传递消息?](doc/HowMessageWork.md)
- [核心UML示意图](doc/UML.md)
- 快速移植: 执行 `1h-1cpp.sh` 可以将所有GuiLite代码合成为1个头文件(GuiLite.h)和1个实现文件(GuiLite.cpp)
- GuiLite滑动及多层叠加原理
- ![GuiLiteGraphic](doc/GuiLiteGraphic.gif)
- [完整视频](https://v.youku.com/v_show/id_XNDI4ODE1ODcwOA)

View File

@ -1,3 +1,4 @@
# How to build & port GuiLite?
## How to build GuiLite libary for Windows?
Prerequisite: Windows 10, visul stdio 2015/2017
- Open "GuiLite.sln" by Visual studio 2017
@ -38,3 +39,25 @@ Prerequisite: Windows 10, visul stdio 2015/2017
- Choose your Device type(Default: STM32F103ZE) from option for target.
- Build GuiLite.
- Output here: /GuiLite/Objects/GuiLite.lib
## How to port?
Here are 2 options for porting. For option 1: you should build GuiLite library, and move all headers files & library to your project; For option 2: You do not need to build GuiLite library, just merge all GuiLite code into 1 header(GuiLite.h) & 1 source(GuiLite.cpp), then move the 2 files to your project.
We recommend option 2, because of:
- Easy to port - no need to buid library
- Easy to move - just 2 files
- Easy to manage header files - just 1 header file
- Easy to debug - no library binary
### Option 1: Header & Library
- Headers: core_include, widgets_include
- Library: The GuiLite library
1. Move core_include/widgets_include to your project
2. Build GuiLite library by above building process
3. Link GuiLite library to your project
4. Rebuild your project
### Option 2: Header & Source
1. Execute `1h-1cpp.sh` to merge the whole source code into: 1 header(GuiLite.h) & 1 source(GuiLite.cpp)
2. Move GuiLite.h/GuiLite.cpp to your project
3. Rebuild your project