diff --git a/README.md b/README.md index 0e64e1e..dcfd32d 100644 --- a/README.md +++ b/README.md @@ -22,15 +22,27 @@ A Wi-Fi-enabled LED matrix clock with weather integration and web-based controls - Smart Automation: Includes automatic brightness scaling based on a set night-mode schedule. +## Hardware Requirements +- Microcontroller: ESP32 Development Board (e.g., ESP32 DevKit V1). + +- Display: 4-in-1 MAX7219 LED Matrix Module (or 4 individual 8x8 modules daisy-chained). + +- Wiring: Jumper wires (Female-to-Female typically used for the matrix connections). + +- Power: 5V Power Supply (Note: If using 4+ modules, it is highly recommended to power the matrix directly from a 5V source rather than the ESP32's 3.3V pin to prevent instability or brownouts). + ## Wiring - DATA: GPIO 13 - CS: GPIO 14 - CLK: GPIO 15 -## include MD_MAX72xx.h -- include -- include -- include -- include -- include -- include \ No newline at end of file +## Library Requirements +To compile this project, the following libraries must be installed in your Arduino IDE (navigate to Sketch > Include Library > Manage Libraries... and search for these names): + +- MD_MAX72xx (by MajicDesigns): Handles the low-level LED matrix driver. + +- MD_Parola (Optional but recommended): Often used alongside MD_MAX72xx for easier text effects, though this project uses pure MD_MAX72xx. + +- NTPClient (by Fabrice Weinberg): Used to sync the time from the internet. + +- ArduinoJson (by Benoit Blanchon): Required to parse the JSON data returned by the OpenWeatherMap API. \ No newline at end of file