This is an automated email from the ASF dual-hosted git repository.

xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git

commit c4b2c650780fda3ca53dc032b42f2e369fd92122
Author: raiden00pl <[email protected]>
AuthorDate: Mon Oct 23 15:43:50 2023 +0200

    Documentaion: migrate graphics/lvgl readme
---
 Documentation/applications/graphics/index.rst      |  8 ++++++-
 Documentation/applications/graphics/lvgl/index.rst | 27 ++++++++++++++++++++++
 2 files changed, 34 insertions(+), 1 deletion(-)

diff --git a/Documentation/applications/graphics/index.rst 
b/Documentation/applications/graphics/index.rst
index af6ce64e76..48494352c5 100644
--- a/Documentation/applications/graphics/index.rst
+++ b/Documentation/applications/graphics/index.rst
@@ -2,10 +2,16 @@
 Graphics Support
 ================
 
+.. toctree::
+   :glob:
+   :maxdepth: 3
+   :titlesonly:
+   
+   */*
+
 - ft80x - FTDI/BridgeTek FT80x library
 - libjpeg - libjpeg JPEG image encoding
 - libyuv - libyuv
-- lvgl - Light and Versatile Graphic Library (LVGL)
 - nxwidgets - NxWidgets
 - nxwm - NuttX Tiny Window Manager (NxWM)
 - pdcurs34 - pdcurses Text User Interface (TUI)
diff --git a/Documentation/applications/graphics/lvgl/index.rst 
b/Documentation/applications/graphics/lvgl/index.rst
new file mode 100644
index 0000000000..0a18e1251c
--- /dev/null
+++ b/Documentation/applications/graphics/lvgl/index.rst
@@ -0,0 +1,27 @@
+====
+LVGL
+====
+
+Usage
+-----
+
+Import with ``#include <lvgl/lvgl.h>`` or ``#include <lvgl.h>``.
+
+Upstream example ported to NuttX is present at ``examples/lvgldemo``.
+
+LVGL can be used with framebuffer device. To find example boards with this
+preconfigured, search for ``CONFIG_GRAPHICS_LVGL=y`` in ``defconfig`` files. 
All of
+them have also ``CONFIG_VIDEO_FB=y`` present.
+
+As a second option, LVGL can talk to a display driver and explicitly draw line
+by line. For this case, there is no preconfigured board present. Go to 
_Porting_
+section of upstream documentation for more hints.
+
+Resources
+---------
+
+- `API documentation with examples 
<https://docs.lvgl.io/latest/en/html/index.html>`_
+- `GitHub / LVGL / LVGL library <https://github.com/lvgl/lvgl>`_
+- `GitHub / LVGL / Examples, tutorials, applications 
<https://github.com/lvgl/lv_examples>`_
+- `GitHub / LVGL / Desktop simulator 
<https://github.com/lvgl/lv_sim_eclipse_sdl>`_
+- `GitHub / LVGL / Web simulator <https://github.com/lvgl/lv_sim_emscripten>`_

Reply via email to