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

README: change littlevgl to lvgl

Browse Source
This commit is contained in:
Gabor Kiss-Vamosi
2020-05-25 05:54:38 +02:00
committed by GitHub
parent 5ea142eaf0
commit 3837988f2d
1 changed files with 13 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -1,7 +1,7 @@
<h1 align="center"> LVGL - Little and Versatile Graphics Library</h1> <h1 align="center"> LVGL - and Versatile Graphics Library</h1>
<p align="center"> <p align="center">
<a href="https://github.com/littlevgl/lvgl/blob/master/LICENCE.txt"><img src="https://img.shields.io/badge/licence-MIT-blue.svg"></a> <a href="https://github.com/lvgl/lvgl/blob/master/LICENCE.txt"><img src="https://img.shields.io/badge/licence-MIT-blue.svg"></a>
<a href="https://github.com/littlevgl/lvgl/releases/tag/v7.0.0"><img src="https://img.shields.io/badge/version-7.0.0-blue.svg"></a> <a href="https://github.com/lvgl/lvgl/releases/tag/v7.0.0"><img src="https://img.shields.io/badge/version-7.0.0-blue.svg"></a>
</p> </p>
<p align="center"> <p align="center">
@@ -26,7 +26,7 @@ LVGL provides everything you need to create embedded GUI with easy-to-use graphi
- [Features](#features) - [Features](#features)
- [Supported devices](#supported-devices) - [Supported devices](#supported-devices)
- [Quick start in a simulator](#quick-start-in-a-simulator) - [Quick start in a simulator](#quick-start-in-a-simulator)
- [Add LittlevGL to your project](#add-littlevgl-to-your-project) - [Add LVGL to your project](#add-lvgl-to-your-project)
- [Learn the basics](#learn-the-basics) - [Learn the basics](#learn-the-basics)
- [Examples](#examples) - [Examples](#examples)
- [Contributing](#contributing) - [Contributing](#contributing)
@@ -50,7 +50,7 @@ LVGL provides everything you need to create embedded GUI with easy-to-use graphi
* **Documentation** and API references * **Documentation** and API references
## Supported devices ## Supported devices
Basically, every modern controller - which is able to drive a display - is suitable to run LittlevGL. The minimal requirements: Basically, every modern controller - which is able to drive a display - is suitable to run LVGL. The minimal requirements:
- 16, 32 or 64 bit microcontroller or processor - 16, 32 or 64 bit microcontroller or processor
- &gt; 16 MHz clock speed is recommended - &gt; 16 MHz clock speed is recommended
- Flash/ROM: &gt; 64 kB for the very essential components (&gt; 180 kB is recommended) - Flash/ROM: &gt; 64 kB for the very essential components (&gt; 180 kB is recommended)
@@ -65,7 +65,7 @@ Basically, every modern controller - which is able to drive a display - is suita
*Note that the memory usage might vary depending on the architecture, compiler and build options.* *Note that the memory usage might vary depending on the architecture, compiler and build options.*
Just to mention some **platforms**: Just to mention some **platforms**:
- STM32F1, STM32F3, [STM32F4](https://blog.lvgl.io/2017-07-15/stm32f429_disco_port), [STM32F7](https://github.com/littlevgl/stm32f746_disco_no_os_sw4stm32) - STM32F1, STM32F3, [STM32F4](https://blog.lvgl.io/2017-07-15/stm32f429_disco_port), [STM32F7](https://github.com/lvgl/stm32f746_disco_no_os_sw4stm32)
- Microchip dsPIC33, PIC24, PIC32MX, PIC32MZ - Microchip dsPIC33, PIC24, PIC32MX, PIC32MZ
- NXP Kinetis, LPC, iMX - NXP Kinetis, LPC, iMX
- [Linux frame buffer](https://blog.lvgl.io/2018-01-03/linux_fb) (/dev/fb) - [Linux frame buffer](https://blog.lvgl.io/2018-01-03/linux_fb) (/dev/fb)
@@ -75,7 +75,7 @@ Just to mention some **platforms**:
- Quectell M66 - Quectell M66
## Quick start in a simulator ## Quick start in a simulator
The easiest way to get started with LittlevGL is to run it in a simulator on your PC without any embedded hardware. The easiest way to get started with LVGL is to run it in a simulator on your PC without any embedded hardware.
Choose a project with your favourite IDE: Choose a project with your favourite IDE:
@@ -85,7 +85,7 @@ Choose a project with your favourite IDE:
| Cross-platform<br>with SDL<br>(Recommended on<br>Linux and Mac) | Native Windows | Windows<br>with SDL | Cross-platform<br>with SDL | Cross-platform<br>with SDL | | Cross-platform<br>with SDL<br>(Recommended on<br>Linux and Mac) | Native Windows | Windows<br>with SDL | Cross-platform<br>with SDL | Cross-platform<br>with SDL |
## Add LittlevGL to your project ## Add LVGL to your project
The steps below show how to setup LVGL on an embedded system with a display and a touchpad. The steps below show how to setup LVGL on an embedded system with a display and a touchpad.
You can use the [Simulators](https://docs.lvgl.io/v7/en/html/get-started/pc-simulator) to get ready to use projects which can be run on your PC. You can use the [Simulators](https://docs.lvgl.io/v7/en/html/get-started/pc-simulator) to get ready to use projects which can be run on your PC.
@@ -153,12 +153,11 @@ It will redraw the screen if required, handle input devices etc.
## Learn the basics ## Learn the basics
In this section you can ready the very basics. For a more detailed guide check the [Quick overview] In this section you can ready the very basics. For a more detailed guide check the [Quick overview](https://docs.lvgl.io/v7/en/html/get-started/quick-overview.html#learn-the-basics) in the documentation.
(https://docs.littlevgl.com/v7/en/html/get-started/quick-overview.html#learn-the-basics) in the documentation.
### Widgets (Objects) ### Widgets (Objects)
The graphical elements like Buttons, Labels, Sliders, Charts etc are called objects in LittelvGL. Go to [Object types](https://docs.littlevgl.com/v7/en/html/widgets/index) to see the full list of available types. The graphical elements like Buttons, Labels, Sliders, Charts etc are called objects in LittelvGL. Go to [Object types](https://docs.lvgl.io/v7/en/html/widgets/index) to see the full list of available types.
Every object has a parent object. The child object moves with the parent and if you delete the parent the children will be deleted too. Children can be visible only on their parent. Every object has a parent object. The child object moves with the parent and if you delete the parent the children will be deleted too. Children can be visible only on their parent.
@@ -224,7 +223,7 @@ void btn_event_cb(lv_obj_t * btn, lv_event_t event)
} }
``` ```
Learn more about the events in the [Event overview](https://docs.littlevgl.com/en/html/overview/event) section. Learn more about the events in the [Event overview](https://docs.lvgl.io/v7/en/html/overview/event) section.
## Examples ## Examples
@@ -272,10 +271,10 @@ If you are interested in contributing to LVGL you can
- **Help others** in the [Forum](https://forum.lvgl.io). - **Help others** in the [Forum](https://forum.lvgl.io).
- **Inspire people** by speaking about your project in [My project](https://forum.lvgl.io/c/my-projects) category in the Forum. - **Inspire people** by speaking about your project in [My project](https://forum.lvgl.io/c/my-projects) category in the Forum.
- **Improve and/or translate the documentation.** Go to the [Documentation](https://github.com/lvgl/docs) repository to learn more - **Improve and/or translate the documentation.** Go to the [Documentation](https://github.com/lvgl/docs) repository to learn more
- **Write a blog post** about your experiences. See how to do it in the [Blog](https://github.com/littlevgl/blog) repository - **Write a blog post** about your experiences. See how to do it in the [Blog](https://github.com/lvgl/blog) repository
- **Report and/or fix bugs** in [GitHub's issue tracker](https://github.com/lvgl/lvgl/issues) - **Report and/or fix bugs** in [GitHub's issue tracker](https://github.com/lvgl/lvgl/issues)
- **Help in the developement**. Check the [Open issues](https://github.com/lvgl/lvgl/issues) especially the ones with [Help wanted](https://github.com/lvgl/lvgl/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) label and tell your ideas about a topic or implement a feature. - **Help in the developement**. Check the [Open issues](https://github.com/lvgl/lvgl/issues) especially the ones with [Help wanted](https://github.com/lvgl/lvgl/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) label and tell your ideas about a topic or implement a feature.
Before sending Pull requests, please read the following guides: Before sending Pull requests, please read the following guides:
- [Contributing guide](https://github.com/littlevgl/lvgl/blob/master/docs/CONTRIBUTING.md) - [Contributing guide](https://github.com/lvgl/lvgl/blob/master/docs/CONTRIBUTING.md)
- [Coding style guide](https://github.com/lvgl/lvgl/blob/master/docs/CODING_STYLE.md) - [Coding style guide](https://github.com/lvgl/lvgl/blob/master/docs/CODING_STYLE.md)