From 07e1126a587d9b6d50d065900d69accba5edf10b Mon Sep 17 00:00:00 2001
From: "Daniele Verducci (Slimpenguin)" <daniele.verducci@gmail.com>
Date: Thu, 21 Dec 2023 08:38:35 +0100
Subject: [PATCH] Updated readme

---
 README.md           |  4 +++-
 esp32-lcd/README.md | 40 +++++++++++++++++++++-------------------
 2 files changed, 24 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index 950c151..93fdce6 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,9 @@ Please see [mddclient documentation](mddclient/README.md)
 
 A status LCD for your homelab! Low cost (about 20€ in parts), simple to build (no circuit board, no components, only an LCD, a ESP32 and, if needed, a potentiometer). Connects to your local wifi and receives HTTP requests from your homelab machines, and shows them to the screen.
 
-![ESP32-LCD prototype](../images/esp32-lcd.jpg)
+![ESP32-LCD prototype](images/esp32-lcd.jpg)
+
+Please see [ESP32-LCD documentation](esp32-lcd/README.md)
 
 # License
 This whole repository is released under GNU General Public License version 3: see http://www.gnu.org/licenses/
diff --git a/esp32-lcd/README.md b/esp32-lcd/README.md
index 667719e..4756b7b 100644
--- a/esp32-lcd/README.md
+++ b/esp32-lcd/README.md
@@ -14,24 +14,24 @@ A status LCD for your homelab.
 
 Connect the LCD to the board:
 
-LCD Pin		ESP32 Pin
-____________________________________
-PIN01-VSS	GND
-PIN02-VDD	5V
-PIN03 V0	10K Pot (Middle pin)
-PIN04 RS	GPIO19
-PIN05 RW	GND
-PIN06  E	GPIO23
-PIN07 D0	NOT USED
-PIN08 D1	NOT USED
-PIN09 D2	NOT USED
-PIN10 D3	NOT USED
-PIN11 D4	GPIO18
-PIN12 D5	GPIO17
-PIN13 D6	GPIO16
-PIN14 D7	GPIO15
-PIN15 A		5V
-PIN16 K		GND
+**LCD Pin  ->  ESP32 Pin**
+
+- PIN01-VSS -> GND
+- PIN02-VDD -> 5V
+- PIN03 V0 ->  10K Pot (Middle pin)
+- PIN04 RS ->  GPIO19
+- PIN05 RW ->  GND
+- PIN06  E ->  GPIO23
+- PIN07 D0 ->  NOT USED
+- PIN08 D1 ->  NOT USED
+- PIN09 D2 ->  NOT USED
+- PIN10 D3 ->  NOT USED
+- PIN11 D4 ->  GPIO18
+- PIN12 D5 ->  GPIO17
+- PIN13 D6 ->  GPIO16
+- PIN14 D7 ->  GPIO15
+- PIN15 A  ->  5V
+- PIN16 K  ->  GND
 
 Connect the potentiometer lateral pins to VCC and GND. Use the potentiometer to set the screen contrast.
 
@@ -47,8 +47,10 @@ Restart the ESP32. The display shows "Conn to wifi..." with the WIFI name in the
 - Make a GET request to the same IP address with a parameter "message" containing some text
 
 > Example: to make the request using CURL from command line, try something along this lines (replace the IP addr with the one shown in the display):
-> curl -G http://192.168.1.78 --data-urlencode "message=Something interesting happened!"
+> `curl -G http://192.168.1.78 --data-urlencode "message=Something interesting happened!"`
 
 ## Troubleshooting
 
 The ESP32 logs are written in the serial monitor at 115200 baud. Just open the Arduino ide Serial Monitor from Tools menu and look at the logs.
+
+If the screen is supplied with power but not initialized (maybe due to bad contacts or non working esp32 firmware), it should show some black blocks on the first line. If you canot see those (nor any other text), first of all check the contrast using the potentiometer.