[rtems-littlevgl PATCH] Add README

[Vijay Kumar Banerjee]

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..161e4d9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+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
-- 
2.21.1