From 9135baf7d2591a907740f30d5ecffb3e77d1f1be Mon Sep 17 00:00:00 2001 From: Vijay Kumar Banerjee Date: Tue, 24 Mar 2020 23:52:28 +0530 Subject: Add README --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d0e7b02 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +RTEMS LittlevGL +=============== + +Welcome to RTEMS LittlevGL (lvgl). This package builds the lvgl library using +waf with the required settings for running it with rtems. The lvgl drivers are +adapted to the BSD framebuffer and hence requires the latest rtems-libbsd build. + +About LittlevGL +--------------- + +LittlevGL is a lightweight graphics library for embedded GUI applications. It +can be configured using the `lv_conf.h` and the `lv_drv_conf.h` files that are +in the top of the rtems-littlevgl directory. + +The documentation is available at: +https://docs.littlevgl.com/en/html/index.html + +Building and installing rtems-littlevgl +--------------------------------------- + +``` +git clone git://git.rtems.org/packages/rtems-littlevgl.git +git submodule update +./waf configure --prefix=/path/to/rtems/5 +./waf build install +``` + +Writing embedded GUI app using rtems-littlevgl +---------------------------------------------- + +The rtems-examples repository has a sample lvgl hello world application that can +be followed for reference on how to write and build an application with lvgl. +The sample app can be found here: +https://git.rtems.org/rtems-examples/tree/lvgl/hello/test.c + +Where to discuss questions and ideas? +------------------------------------- + +The preferred way of carrying out any discussions or questions is to reach out +to the users mailing list users@rtems.org or the devel mailing list +devel@rtems.org for more detailed discussions. + +In any discussions related to rtems-littlevgl, the maintainers can be CC'd by +their respective id's given below: + +Christian Mauderer (christian.mauderer@embedded-brains.de) +Vijay Kumar Banerjee (vijay@rtems.org) -- cgit v1.2.3