/doc

Documentation of LittlevGL embedded GUI library

Primary LanguageHTML

Welcome to the documentation page of LittlevGL

LittlevGL is a free and open-source graphics library providing everything you need to create embedded GUI with easy-to-use graphical elements, beautiful visual effects and low memory footprint.

Website: https://littlevgl.com/
Main repository: https://github.com/littlevgl/lvgl

The documentation is available in:

How to use this documentation

The documentation is written in Markdown. There are lot of converter tools to get 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 exixting 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 pagesa re welcome!

To push back your updates please craete Pull request.

Improve the documentation

If you find some missing information, typo or unclear parts, please add you fixes in a Pull request.