Skip to content

Commit ce0bccb

Browse files
committed
Create README.md
1 parent 80a4aa7 commit ce0bccb

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Introduction
2+
## What is µGUI?
3+
µGUI is a free and open source graphic library for embedded systems. It is platform-independent
4+
and can be easily ported to almost any microcontroller system. As long as the display is capable
5+
of showing graphics, µGUI is not restricted to a certain display technology. Therefore, display
6+
technologies such as LCD, TFT, E-Paper, LED or OLED are supported. The whole module
7+
consists of three files: **ugui.c**, **ugui.h** and **ugui_config.h**.
8+
9+
## µGUI Features
10+
* µGUI supports any color, grayscale or monochrome display
11+
* µGUI supports any display resolution
12+
* µGUI supports multiple different displays
13+
* µGUI supports any touch screen technology (e.g. AR, PCAP)
14+
* µGUI supports windows and objects (e.g. button, textbox)
15+
* µGUI supports platform-specific hardware acceleration
16+
* 16 different fonts available
17+
* cyrillic fonts supported
18+
* TrueType font converter available ([https://github.com/AriZuu](https://github.com/AriZuu))
19+
* integrated and free scalable system console
20+
* basic geometric functions (e.g. line, circle, frame etc.)
21+
* can be easily ported to almost any microcontroller system
22+
* no risky dynamic memory allocation required
23+
24+
## µGUI Requirements
25+
µGUI is platform-independent, so there is no need to use a certain embedded system. In order to
26+
use µGUI, only two requirements are necessary:
27+
* a C-function which is able to control pixels of the target display.
28+
* integer types for the target platform have to be adjusted in ugui_config.h.

0 commit comments

Comments
 (0)