github-code/lvgl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(README): imporve style

Browse Source
This commit is contained in:
Gabor Kiss-Vamosi
2022-07-13 21:57:19 +02:00
committed by GitHub
parent 891aee1e8e
commit 5dba46de72
1 changed files with 68 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

136
README.md
View File

@@ -27,7 +27,7 @@ The last stable version is available in the [release/v8.3](https://github.com/lv
</p>
<br>
## Overview
## :monocle_face: Overview
LVGL is the most popular free and open source embedded graphics library to create beautiful UIs for any MCU, MPU and display type. It's supported by industry leading vendors and projects like  **Arm, STM32, NXP, Espressif, Nuvoton, Arduino, RT-Thread, Zephyr, NuttX, Adafruit and many more**.
@@ -38,72 +38,67 @@ It has all the features to create modern and beautiful GUIs: 30+ built-in widget
Our team is ready to help you with **UI design, implementation and consulting services**. Feel free to contact us if you need some support during the development of your next UI.
## Features
## :rocket: Features
### Free and Portable
- **Fully portable** LVGL is a C (C++ compatible) library with no external dependencies. It can be compiled to any microcontrollers or microprocessors, with any (RT)OS to drive monochrome, ePaper, OLED or TFT displays, or even monitors.
**Free and Portable**
- A fully portable C (C++ compatible) library with no external dependencies.
- It can be compiled to any MCU or MPU, with any (RT)OS
- Support monochrome, ePaper, OLED or TFT displays, or even monitors.
- Distributed under the MIT licence, so you can easily use it in commercial projects too.
- Needs only 32kB RAM and 128 kB Flash, a frame buffer, and at least an 1/10 screen sized buffer for rendering.
- OS, External memory and GPU are supported but not required.
- **Free** LVGL is distributed under the MIT licence, so you can easily use it in commercial projects too.
**Widgets, Styles, Layouts and more**
- 30+ built-in widgets:  Button, Label, Slider, Chart, Keyboard, Meter, Arc, Table and many more.
- Flexible style system with  ~100 style properties to customize any part of the widgets in any state.
- Flexbox and Grid-like layouts engines to automatically size and position the widgets in a responsive way.
- Texts are rendered with UTF-8 encoding supporting CJK, Thai, Hindi, Arabic, Persian writing systems.
- Word wrapping, kerning, text scrolling, sub-pixel rendering, Pinyin-IME Chinese input, Emojis in texts.
- Rendering engine supporting animations, anti-aliasing, opacity, smooth scrolling, shadows, image transformation, etc  
- Supporting mouse, touchpad, Keypad, keyboard, external buttons, encoder.
- Multiple display support
**Binding and Build Support**
- [Micropython binding](https://blog.lvgl.io/2019-02-20/micropython-bindings) exposes LVGL API
- No custom build system is used. You can build LVGL as you build the other files of your project.
- Support for Make and CMake is included out of the box.
- Develop on PC and use the same UI code on embedded hardware.
- Convert C UI code to HTML file with our [Emscripten port](https://github.com/lvgl/lv_web_emscripten).
- **Minimal requirements** C99 or newer compiler, minimum 32kB RAM and 128 kB flash, a frame buffer, and at least an 1/10 screen sized buffer for rendering. OS, External memory and GPU are supported but not required.
**Docs, Tools, and Services**
- Detailed docs with [100+ simple examples](https://docs.lvgl.io/master/index.html)
- [SquareLine Studio](https://squareline.io/) - A professional and easy-to-use UI editor software to speed up and simplify the UI development.
- [Services](https://lvgl.io/services) such as user interface design, implementation and consulting to make UI development simpler and faster.
### Widgets, Styles, Layouts and more
- **30+ built-in widgets**  Button, Label, Slider, Chart, Keyboard, Meter, Arc, Table and many more.
- **Flexible style system**  ~100 style properties (e.g. radius, opacity, gradient, border, shadow, etc.) allow you to customize any part of the widgets (e.g. background, scrollbar, indicator, knob, etc) in any state (normal, pressed, check, focused, etc).
- **Powerful layout engine** Flexbox and Grid-like layouts to automatically size and position the widgets in a responsive way
- **Advanced text features** Texts are rendered with UTF-8 encoding supporting CJK, Thai, Hindi, Arabic, Persian writing systems. Word wrapping, kerning, text scrolling, sub-pixel rendering, Pinyin-IME Chinese input, Emojis in texts are also available out of the box.
- **Fast rendering engine** Supporting animations, anti-aliasing, opacity, smooth scrolling, blending modes, rounded rectangles, image transformation, etc  
- **Various Input Devices** Supporting mouse, touchpad, Keypad, keyboard, external buttons, encoder.
- **Multiple display support** Use one MCU to drive more screens.
### Binding and Build Support
- **Micropython binding** Exposes [LVGL API in Micropython](https://blog.lvgl.io/2019-02-20/micropython-bindings)
- **No custom build system** LVGL is distributed as an organized collection of C files that can be easily integrated into any build system. Support for Make and CMake is included out of the box.
- **Develop on PC** Use the same UI code on PC and embedded hardware.
- **Convert the UI to HTML** You can compile the C UI code to a single HTML file with our [Emscripten port](https://github.com/lvgl/lv_web_emscripten).
### Docs, Tools, and Services
- **Detailed docs** with [100+ simple examples](https://docs.lvgl.io/master/index.html)
- **SquareLine Studio** A professional and easy-to-use UI editor software to speed up and simplify the UI development.
 
- **Services** User interface design, implementation and consulting services to make UI development simpler and faster
## Get started
## :arrow_forward: Get started
This list will guide you to get started with LVGL step-by-step.
### Get Familiar with LVGL
1. Check the [Online demos](https://lvgl.io/demos) to see LVGL in action (3 minutes)
2. Read the [Introduction](https://docs.lvgl.io/master/intro/index.html) page of the documentation (5 minutes)
3. Get familiar with the basics on the [Quick overview](https://docs.lvgl.io/master/get-started/quick-overview.html) page (15 minutes)
### Start to Use LVGL
4. Set up a [Simulator](https://docs.lvgl.io/master/get-started/platforms/pc-simulator.html) (10 minutes)
5. Try out some [Examples](https://github.com/lvgl/lvgl/tree/master/examples)
6. Port LVGL to a board. See the [Porting](https://docs.lvgl.io/master/porting/index.html) guide or check the ready to use [Projects](https://github.com/lvgl?q=lv_port_)
**Get Familiar with LVGL**
1. Check the [Online demos](https://lvgl.io/demos) to see LVGL in action (3 minutes)
2. Read the [Introduction](https://docs.lvgl.io/master/intro/index.html) page of the documentation (5 minutes)
3. Get familiar with the basics on the [Quick overview](https://docs.lvgl.io/master/get-started/quick-overview.html) page (15 minutes)
### Become a Pro
7. Read the [Overview](https://docs.lvgl.io/master/overview/index.html) page to get a better understanding of the library (2-3 hours)
8. Check the documentation of the [Widgets](https://docs.lvgl.io/master/widgets/index.html) to see their features and usage
**Start to Use LVGL**
4. Set up a [Simulator](https://docs.lvgl.io/master/get-started/platforms/pc-simulator.html) (10 minutes)
5. Try out some [Examples](https://github.com/lvgl/lvgl/tree/master/examples)
6. Port LVGL to a board. See the [Porting](https://docs.lvgl.io/master/porting/index.html) guide or check the ready to use [Projects](https://github.com/lvgl?q=lv_port_)
### Get Help and Help Others
9. If you have questions go to the [Forum](http://forum.lvgl.io/)
10. Read the [Contributing](https://docs.lvgl.io/master/CONTRIBUTING.html) guide to see how you can help to improve LVGL (15 minutes)
**Become a Pro**
### Go for More
11. Download and try out [SquareLine Studio](https://squareline.io/).
12. Contact us for [Services](https://lvgl.io/services).
7. Read the [Overview](https://docs.lvgl.io/master/overview/index.html) page to get a better understanding of the library (2-3 hours)
8. Check the documentation of the [Widgets](https://docs.lvgl.io/master/widgets/index.html) to see their features and usage
## Packages
**Get Help and Help Others**
9. If you have questions go to the [Forum](http://forum.lvgl.io/)
10. Read the [Contributing](https://docs.lvgl.io/master/CONTRIBUTING.html) guide to see how you can help to improve LVGL (15 minutes)
**Go for More**
11. Download and try out [SquareLine Studio](https://squareline.io/).
12. Contact us for [Services](https://lvgl.io/services).
## :package: Packages
LVGL is available as:
- [Arduino library](https://docs.lvgl.io/master/get-started/platforms/arduino.html)
- [PlatformIO package](https://registry.platformio.org/libraries/lvgl/lvgl)
@@ -114,9 +109,9 @@ LVGL is available as:
- [RT-Thread RTOS](https://docs.lvgl.io/master/get-started/os/rt-thread.html)
- CMSIS-Pack
## Examples
## :man_technologist: Examples
For more examples see the [examples](https://github.com/lvgl/lvgl/tree/master/examples) folder.
See how to create a button with a click event in C and MicroPython. For more examples see the [Examples](https://github.com/lvgl/lvgl/tree/master/examples) folder.
![LVGL button with label example](https://github.com/lvgl/lvgl/raw/master/docs/misc/btn_example.png)
@@ -138,7 +133,6 @@ void btn_event_cb(lv_event_t * e)
}
```
### Micropython
Learn more about [Micropython](https://docs.lvgl.io/master/get-started/bindings/micropython.html).
```python
def btn_event_cb(e):
  print("Clicked")
@@ -154,17 +148,23 @@ label.set_text("Button")
label.center()
```
## Services
LVGL Kft was established to provide a solid background for LVGL library. We offer several type of services to help you in UI development:
- Graphics design
- UI implementation
- Consulting/Support
Learn more about [Micropython](https://docs.lvgl.io/master/get-started/bindings/micropython.html).
For more information see https://lvgl.io/services
Feel free to contact us if you have any questions.
## :handshake: Services
LVGL LLC was established to provide a solid background for LVGL library and to offer several type of services to help you in UI development. With 15+ years of experience in the user interface and graphics industry we can help you the bring your UI to the next level.
- **Graphics design** Our in-house graphics designers are experts in creating beautiful modern designs which fit to your product and the resources of your hardware.
- **UI implementation** We can also implement your UI based on the design you or we have created. You can be sure that we will make the most out of your hardware and LVGL. If a feature or widget is missing from LVGL, don't worry, we will implement it for you.
- **Consulting and Support** We can support you with consulting as well to avoid pricey and time consuming mistakes during the UI development.
- **Board certificate** For companies who are offering development boards, or production ready kits we do board certification which shows how board can run LVGL.
## Contributing
Check out our [Demos](https://lvgl.io/demos) as reference. For more information take look at the [Services page](https://lvgl.io/services).
[Contact us](https://lvgl.io/#contact) and tell how we can help.
## :star2: Contributing
LVGL is an open project and contribution is very welcome. There are many ways to contribute from simply speaking about your project, through writing examples, improving the documentation, fixing bugs to hosting your own project under the LVGL organization.
For a detailed description of contribution opportunities visit the [Contributing](https://docs.lvgl.io/master/CONTRIBUTING.html) section of the documentation.