firmware update to support display on ESP32-C6-LCD-1.47

README.md

@@ -19,21 +19,34 @@ This is a Firmware for ESP32-based boards to encrypt / decrypt seed phrases and
 This firmware is making use of:
 - [ESP32 board definition](https://github.com/espressif/arduino-esp32) => install "esp32" by Espressif Systems in the boards manager inside the Arduino IDE
 - [Arduino Cryptography Library](https://rweather.github.io/arduinolibs/crypto.html) => install the library "Crypto" by Rhys Weatherley inside the Arduino IDE
+- [GFX Library for Arduino](https://github.com/moononournation/Arduino_GFX) => install the library "GFX Library for Arduino" by Moon On Our Nation inside the Arduino IDE
 
 ## License
 
-This firmware is open source licensed under the [EUROPEAN UNION PUBLIC LICENCE (EUPL) v. 1.2](LICENSE).
-You can do with and modify it however you want.
-You cannot hold us liable for any loss or damage caused by the use of this firmware. You will use it on your own risk.
+This firmware is open source licensed under the [EUROPEAN UNION PUBLIC LICENCE (EUPL) v. 1.2](LICENSE).  
+You can do with and modify it however you want.  
+You cannot hold us liable for any loss or damage caused by the use of this firmware. You will use it on your own risk.  
 
-## Installation
+## Hardware
 
+This project was solely developed to make use of the [Waveshare ESP32-C6-LCD-1.47 board](https://docs.waveshare.com/ESP32-C6-LCD-1.47) or any of its clones.  
+The firmware is able to run on pretty much any ESP32 microcontroller though. But some tweaking for other displays may be needed.
+
+## Installation of the Firmware
+
+- Install Arduino IDE (if it was not installed already)
 - Download this repository to your computer
 - Install the needed board definitions and libraries
 - select the board that you'd like to use from the tools menu
 - selct the serial port your board is connected to in the tools menu
+- set the compiler directives according to your likings
+    * PRINT_SERIAL = 1 for information sent back to the serial terminal
+    * DEBUG = 1 if you'd like some more verbose feedback sent to the serial terminal
+    * USE_DISPLAY = 1 if you were using a board with a display connected
+    * HAS_KEYBOARD = 1 if you were using a matrix keyboard connected to the microcontroller
+    * DEBUG_DISPLAY = 1 (in display.h) to receive some more verbose feedback from the display driver
 - hit the upload button
-- wait for the compilation and upload to complete
+- wait for the compilation and upload to complete; this may take a while due to the compilation time of the libraries involved
 
 ## Usage
 
@@ -145,5 +158,6 @@ decrypt 49 04 36 FE DD 5D ED 78 D4 7F EF 1B 82 6F 6C 2A 83 4E 38 8F BB D0 34 F1
 ## notes on issues and security
 
 - Send any findings in the cryptographic library to [the original author of the library](https://github.com/rweather/arduinolibs)
-- any issues on the firmware implementaion: contact us on the [fediverse @schauausgmbh@social.schauaus.at](https://social.schauaus.at/@schauausgmbh) or Matrix @schauausgmbh:matrix.schauaus.at
+- Send any findings in the Arduino GFX library to [the original author of the library](https://github.com/moononournation/Arduino_GFX)
+- any issues on the firmware implementaion: contact us on the [fediverse @schauausgmbh@social.schauaus.at](https://social.schauaus.at/@schauausgmbh) or on Matrix @schauausgmbh:matrix.schauaus.at
 - any security issues on the firmware: contact us on Matrix @schauausgmbh:matrix.schauaus.at