From 03f37d79c5108b3754add8feb3a797d0cb378f5d Mon Sep 17 00:00:00 2001 From: idea4good Date: Fri, 15 Dec 2017 22:57:26 +0800 Subject: [PATCH] update docs --- README.md | 6 +++-- core/README.md | 13 ---------- GraphicLayer.png => doc/GraphicLayer.png | Bin doc/HowToBuild.md | 29 +++++++++++++++++++++++ demo.gif => doc/demo.gif | Bin gui/README.md | 13 ---------- 6 files changed, 33 insertions(+), 28 deletions(-) delete mode 100644 core/README.md rename GraphicLayer.png => doc/GraphicLayer.png (100%) create mode 100644 doc/HowToBuild.md rename demo.gif => doc/demo.gif (100%) delete mode 100644 gui/README.md diff --git a/README.md b/README.md index 82fedde..a27ea59 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # GuiLite 揭示UI原理,打造你自己的UI(框架)- 开发者qq群:527251257 -![Demo](demo.gif) +![Demo](doc/demo.gif) + +![编译方法](doc/HowToBuild.md) 超轻量UI框架 - GuiLite是由6千行左右的C/C++代码编写而成,它像MFC,QT一样为开发者提供界面支持。 @@ -50,7 +52,7 @@ GuiLite只作两个工作:界面元素管理和图形绘制。 ### 图层管理 GuiLite的所有图层,如下图所示: -![Graphic layer](GraphicLayer.png) +![Graphic layer](doc/GraphicLayer.png) display层: 该层对应了物理显存,display层决定了一个显示终端的最终显示效果;通常系统中至少有一个display层。 diff --git a/core/README.md b/core/README.md deleted file mode 100644 index e010b1a..0000000 --- a/core/README.md +++ /dev/null @@ -1,13 +0,0 @@ -## How to build core libary for Windows? -depdency: Windows 10, visul stdio 2015/2017 -- Open "core.sln" by Visual studio 2017 -- Click `build` - -## How to build core libary for Linux(x64 & arm)? -- `cmake .` -- `make` - -## How to build core libary for Android? -- `sudo apt-get install gcc-arm-linux-androideabi` -- `cmake cmake -D CMAKE_C_COMPILER="/usr/bin/arm-linux-androideabi-gcc" -D CMAKE_CXX_COMPILER="/usr/bin/arm-linux-androideabi-g++" .` -- `make` diff --git a/GraphicLayer.png b/doc/GraphicLayer.png similarity index 100% rename from GraphicLayer.png rename to doc/GraphicLayer.png diff --git a/doc/HowToBuild.md b/doc/HowToBuild.md new file mode 100644 index 0000000..b013cb9 --- /dev/null +++ b/doc/HowToBuild.md @@ -0,0 +1,29 @@ +## How to build core&gui libary for Windows? +depdency: Windows 10, visul stdio 2015/2017 +- Open "GuiLite.sln" by Visual studio 2017 +- Click `Build Solution` +- Output here: \GuiLite\Debug(Release)\core.lib gui.lib + +## How to build core&gui libary for Mac and Linux(x64 & raspberry pi)? +- `cd GuiLite` +- `cmake .` +- `make` +- Output here: /GuiLite/libcore.a libgui.a + +## How to build core&gui libary for ARM Linux? +### Install cross compiler: +For example: arm-linux-gnueabi-gcc +`sudo apt-get install g++-arm-linux-gnueabi` +`sudo apt-get install gcc-arm-linux-gnueabi` + +- `cd GuiLite` +- `cmake -D CMAKE_C_COMPILER="/usr/bin/arm-linux-gnueabi-gcc" -D CMAKE_CXX_COMPILER="/usr/bin/arm-linux-gnueabi-g++" .` +- `make` +- Output here: /GuiLite/libcore.a libgui.a + +## How to build core&gui libary for Android? +- `cd GuiLite` +- `sudo apt-get install gcc-arm-linux-androideabi` skip this if you have got the tool +- `cmake -D CMAKE_C_COMPILER="/usr/bin/arm-linux-androideabi-gcc" -D CMAKE_CXX_COMPILER="/usr/bin/arm-linux-androideabi-g++" .` +- `make` +- Output here: /GuiLite/libcore.a libgui.a diff --git a/demo.gif b/doc/demo.gif similarity index 100% rename from demo.gif rename to doc/demo.gif diff --git a/gui/README.md b/gui/README.md deleted file mode 100644 index d023a22..0000000 --- a/gui/README.md +++ /dev/null @@ -1,13 +0,0 @@ -## How to build gui libary for Windows? -depdency: Windows 10, visul stdio 2015/2017 -- Open "gui.sln" by Visual studio 2017 -- Click `build` - -## How to build gui libary for Linux(x64 & arm)? -- `cmake .` -- `make` - -## How to build gui libary for Android? -- `sudo apt-get install gcc-arm-linux-androideabi` -- `cmake cmake -D CMAKE_C_COMPILER="/usr/bin/arm-linux-androideabi-gcc" -D CMAKE_CXX_COMPILER="/usr/bin/arm-linux-androideabi-g++" .` -- `make`