From f3b660d0abc55a93a29e05bc10a7653489a49f80 Mon Sep 17 00:00:00 2001
From: timeconfusing <47795198+timeconfusing@users.noreply.github.com>
Date: Fri, 22 Mar 2019 18:07:03 -0700
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bd34a75
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# v5gui
+Example LVGL GUI code for Vex V5 Brain
+
+The GUI consists of two regions: the Button Region and the Status Region. Inside the Status region is a Label object. This split is done to make sure the status information can be display if the buttons exceed the size of the button region.
+
+There are two examples included. They are selected by the #define USE_BTNM_GUI. If uncommented the demo uses individual buttons that can be placed anywhere on the screen. If commnted out it uses a button matrix.
+
+Individual buttons are placed on the screen using using lv_obj_align. All buttons use one callback function defined by lv_btn_set_action. The lv_obj_set_free_num assigns a numeric value to the button pressed for the callback function to use.
+
+The button matrix allow for fast definition of multiple rows and columns of buttons. The defintion of the matrix is as follows:
+ 
+ // Create a button descriptor string array w/ no repeat "\224"
+  static const char * btnm_map[] = { "\2241", "\2242", "\2243", "\n",
+                                     "\2244", "\2245", "\2246", "" };
+ 
+The escape section prevents a press of the button being interpreted as a multipress of the button. The matrix is created by lv_btnm_set_map. The last character in the string for the button_map is what the callback function receives when pressed. The callback function is defined by lv_btnm_set_action.