forgetest5
/
uiLitejhksdhkfj
mirror of https://gitee.com/idea4good/GuiLite.git
1
0
Fork 0
Code Issues Releases Wiki Activity
uiLitejhksdhkfj/README.md

131 lines
9.5 KiB
Markdown
Raw Normal View History

redesign readme
2019-12-13 12:19:59 +08:00
# Welcome to GuiLite
!21 add guilite cube * add GuiLite cube * rename fb.rect to fb.visible_rect
2019-07-18 18:03:49 +08:00
<p align="center">
redesign readme
2019-12-13 12:19:59 +08:00
<img src="documents/logo.png" alt="Logo"/>
</p>
<p align="center">
<img src="https://img.shields.io/badge/build-passing-brightgreen.svg">
<img src="https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS%20%7C%20iOS%20%7C%20Android%20%7C%20MCU-brightgreen.svg">
<img src="https://img.shields.io/badge/architecture-amd64%20%7C%20arm%20%7C%20arm64-blue.svg">
<img src="https://img.shields.io/badge/license-Apache%202-blue.svg">
</p>
!27 Support header-only
2020-01-22 11:03:29 +08:00
<p align="center">The smallest header-only GUI library(5 KLOC) for all platforms</p>
redesign readme
2019-12-13 12:19:59 +08:00
<p align="center">
<img src="documents/WhyGuiLite.png" alt="Why GuiLite"/>
!21 add guilite cube * add GuiLite cube * rename fb.rect to fb.visible_rect
2019-07-18 18:03:49 +08:00
</p>
add en/cn readme
2019-06-13 09:44:37 +08:00
- [中文](README_zh.md)
update readme
2019-08-19 18:00:37 +08:00
redesign readme
2019-12-13 12:19:59 +08:00
## Lightweight
!27 Support header-only
2020-01-22 11:03:29 +08:00
- ✂️Small: 5,000- lines of C++ code & header-only: GuiLite.h
redesign readme
2019-12-13 12:19:59 +08:00
- ⚡Fast: Render GUI within one invoking, independent of any OS & 3rd party library
!27 Support header-only
2020-01-22 11:03:29 +08:00
- 💉Embeddable: Run inside Qt/MFC/Winform/Cocoa/Web - Keep legacy Qt/MFC code reusable
redesign readme
2019-12-13 12:19:59 +08:00
- ⚙️️Hardware Minimum Requirment:
add en/cn readme
2019-06-13 09:44:37 +08:00
redesign readme
2019-12-13 12:19:59 +08:00
| Processor | Disk/ROM space | Memory |
| --- | --- | --- |
| 24 MHZ | 29 KB | 9 KB |
add en/cn readme
2019-06-13 09:44:37 +08:00
redesign readme
2019-12-13 12:19:59 +08:00
## Cross platforms
update readme
2019-12-13 22:58:08 +08:00
- Support OS: iOS/macOS/WathOS, Android, Linux, Windows, RTOS... or **MCU without OS**
update readme
2019-12-14 13:10:47 +08:00
- Support language: C/C++, Swift, Java, Javascript, C#, Golang...
fix typo
2019-12-13 23:00:44 +08:00
- Support 3rd party library: Qt, MFC, Winforms, CoCoa...
add en/cn readme
2019-06-13 09:44:37 +08:00
redesign readme
2019-12-13 12:19:59 +08:00
## Useful features
- 🔣Multi-language, support UTF-8
- 🔨[Toolkit](https://github.com/idea4good/GuiLiteToolkit) for building font/image resource
- 📐[Layout GUI WYSIWYG](https://github.com/idea4good/GuiLitePreviewer)
- ☁️Cloud + IoT Solution
- 📊Code Telemetry & Analysis in real time
- 📦Support 3D & [Web](https://github.com/idea4good/GuiLiteWeb)
- 🐋Run docker with single command: `sudo docker run -it --privileged -v /dev:/dev-share idea4good/gui-lite:latest bash /run.sh`
add en/cn readme
2019-06-13 09:44:37 +08:00
redesign readme
2019-12-13 12:19:59 +08:00
## Easy to learn & Full support
Even C beginner, could master GuiLite quickly. The source code only use basic C++ feature(e,g: class, virtual function). We choose C++ for it could make the code size small significantly, and easy to read.
- 📚Documents
!27 Support header-only
2020-01-22 11:03:29 +08:00
- [How to use GuiLite?](documents/HowToUse.md)
refactor folder
2019-11-08 23:11:45 +08:00
- [Design specification](documents/HowToWork.md)
- [How to Layout widgets?](documents/HowLayoutWork.md)
add en/cn readme
2019-06-13 09:44:37 +08:00
- [How to build unicode font/bitmap resource?](https://github.com/idea4good/GuiLiteToolkit)
redesign readme
2019-12-13 12:19:59 +08:00
- [How to switch theme?](https://gitee.com/idea4good/GuiLiteSamples/blob/master/HostMonitor/UIcode/source/resource/resource.cpp)
refactor folder
2019-11-08 23:11:45 +08:00
- [How to dispatch messages?](documents/HowMessageWork.md)
- [UML chart of GuiLite core](documents/UML.md)
redesign readme
2019-12-13 12:19:59 +08:00
- 📈Learning steps
1. Build GuiLite library
2. Build/Run HelloXXX demos
3. Read/Modify `HelloXXX/UIcode/UIcode.cpp` code
4. Read/Modify `gui` code
5. Read/Modify `core` code
6. Build your UI framework
- 📞[Reach out us](#community-channel) if you have any question, and welcome to our devloper family.
- 🌐[GitHub link](https://github.com/idea4good/GuiLite)
add en/cn readme
2019-06-13 09:44:37 +08:00
redesign readme
2019-12-13 12:19:59 +08:00
## Demo wall
!27 Support header-only
2020-01-22 11:03:29 +08:00
Click the image you like, and run it on your hardware
redesign readme
2019-12-13 12:19:59 +08:00
<table>
<tr>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/Hello3D"><img src="documents/Hello3D.gif" width="200px;"/><br /><sub><b>3D on STM32</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloWave"><img src="documents/HelloWave.gif" width="200px;"/><br /><sub><b>Wave on STM32</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloParticle"><img src="documents/HelloParticle.gif" width="200px;"/><br /><sub><b>Particle on STM32</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloStar"><img src="documents/HelloStar.gif" width="200px;"/><br /><sub><b>Star on STM32</b></sub></a>
</tr>
<tr>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloNets"><img src="documents/HelloNets-mcu.gif" width="200px;"/><br /><sub><b>Nets on STM32</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloNoTouch"><img src="documents/HelloNoTouch.gif" width="200px;"/><br /><sub><b>Keyboard on STM32</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloMario"><img src="documents/HelloMario.gif" width="200px;"/><br /><sub><b>Mario on STM32</b></sub></a>
update readme
2020-01-07 18:04:44 +08:00
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloCircle"><img src="documents/HelloCircle.gif" width="200px;"/><br /><sub><b>3D circle on STM32</b></sub></a>
redesign readme
2019-12-13 12:19:59 +08:00
</tr>
update doc for helloTimer
2020-02-03 16:07:39 +08:00
<tr>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloTimer"><img src="documents/HelloTimer.gif" width="200px;"/><br /><sub><b>Timer</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloSlide"><img src="documents/HelloSlide.gif" width="200px;"/><br /><sub><b>Swipe view</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloAnimation"><img src="documents/HelloAnimation.gif" width="200px;"/><br /><sub><b>Animation</b></sub></a>
</tr>
redesign readme
2019-12-13 12:19:59 +08:00
<tr>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/Hello3D"><img src="documents/iWatch.hello3D.gif" width="200px;"/><br /><sub><b>3D on Apple Watch</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloWave"><img src="documents/iWatch.helloWave.gif" width="200px;"/><br /><sub><b>Wave on Apple Watch</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloParticle"><img src="documents/iOS.particle.gif" width="200px;"/><br /><sub><b>Particle on iPhone</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HostMonitor"><img src="documents/iOS.gif" width="200px;"/><br /><sub><b>HostMonitor on iPhone</b></sub></a>
</tr>
</table>
add en/cn readme
2019-06-13 09:44:37 +08:00
redesign readme
2019-12-13 12:19:59 +08:00
<table>
<tr>
<td align="center"><a href="https://github.com/idea4good/GuiLitePreviewer"><img src="documents/Previewer.gif" width="600px;"/><br /><sub><b>Layout GUI</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloGuiLite"><img src="documents/HelloGuiLite.gif" width="600px;"/><br /><sub><b>Run Windows on Linux</b></sub></a>
</tr>
<tr>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloFont"><img src="documents/HelloFont.gif" width="600px;"/><br /><sub><b>Multi-language</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HostMonitor"><img src="documents/BuildInfo.png" width="600px;"/><br /><sub><b>Code Telemetry & Analysis in real time</b></sub></a>
</tr>
update doc
2020-02-13 20:02:49 +08:00
<tr>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloScroll"><img src="documents/HelloScroll.gif" width="600px;"/><br /><sub><b>Scroll widget</b></sub></a>
</tr>
redesign readme
2019-12-13 12:19:59 +08:00
</table>
add en/cn readme
2019-06-13 09:44:37 +08:00
redesign readme
2019-12-13 12:19:59 +08:00
<table>
<tr>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloNets"><img src="documents/HelloNets-pc.gif" width="300px;"/><br /><sub><b>3D Nets on Windows/Linux</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HelloWidgets"><img src="documents/HelloWidgets.gif" width="300px;"/><br /><sub><b>How to use widgets</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HostMonitor"><img src="documents/unicode.jpg" width="300px;"/><br /><sub><b>Multi-language</b></sub></a>
</tr>
<tr>
<td align="center"><a href="https://github.com/idea4good/GuiLiteWeb"><img src="documents/GuiLite3D.gif" width="300px;"/><br /><sub><b>3D on Web</b></sub></a>
<td align="center"><a href="https://github.com/idea4good/GuiLiteWeb"><img src="documents/GuiLiteCube.gif" width="300px;"/><br /><sub><b>3D on Web</b></sub></a>
<td align="center"><a href="https://github.com/idea4good/GuiLiteWeb"><img src="documents/GuiLiteGraphic.gif" width="300px;"/><br /><sub><b>Tutorial on Web</b></sub></a>
</tr>
<tr>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HostMonitor"><img src="documents/HostMonitor.gif" width="300px;"/><br /><sub><b>HostMonitor on Windows</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HostMonitor"><img src="documents/data_on_cloud.png" width="300px;"/><br /><sub><b>HostMonitor on IoT-Cloud</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HostMonitor"><img src="documents/Android.gif" width="300px;"/><br /><sub><b>HostMonitor on Android</b></sub></a>
</tr>
<tr>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HostMonitor"><img src="documents/WinMR.gif" width="300px;"/><br /><sub><b>HostMonitor on Windows Mixed Reality</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HostMonitor"><img src="documents/Mac.gif" width="300px;"/><br /><sub><b>HostMonitor on Mac</b></sub></a>
<td align="center"><a href="https://gitee.com/idea4good/GuiLiteSamples/tree/master/HostMonitor"><img src="documents/Linux.gif" width="300px;"/><br /><sub><b>HostMonitor on Linux</b></sub></a>
</tr>
</table>
add en/cn readme
2019-06-13 09:44:37 +08:00
add emoji on readme
2019-10-18 14:21:41 +08:00
## 📞Community Channel
Thanks for the help from community, you guys make GuiLite better! And welcome new friend to join us.
- [**@Twitter**](https://twitter.com/idea4good)
refactor folder
2019-11-08 23:11:45 +08:00
- QQ code: [<img src="documents/qq.group.jpg">](https://jq.qq.com/?_wv=1027&k=5EO8D9i)