Welcome to the documentation page of LittlevGL
LittlevGL is a free and open-source graphics library providing everything you need to create an embedded GUI with easy-to-use graphical elements, beautiful visual effects and a low memory footprint.
Website: https://littlevgl.com/
Main repository: https://github.com/littlevgl/lvgl
The documentation is available in:
- HTML format: http://docs.littlevgl.com/
- PDF format: https://github.com/littlevgl/docs/tree/master/pdf
How to use this documentation
The documentation is written in Markdown. There are many converter tools available to generate HTML or PDF from Markdown files.
To generate the HTML and PDF files we used gwtc and ./build.sh
in the root folder.
Contributing
Contributing is very welcome in this repository!
Translate existing pages
You can translate the existing documentation. Just copy the md
files from the root folder to locale/code/
where code
is the abbreviation code of the language. For example de
for German ans fr
for Franch. See the full list here.
You don't need to translate all the pages. Even one or two pages are welcome!
To push back your updates please create Pull request.
Improve the documentation
If you find some missing information, typo or unclear parts, please add you fixes in a Pull request.