From 5647dc6e6b1dbf239aac6c1a4d6520c3b60a01bb Mon Sep 17 00:00:00 2001 From: Garage Tinkering Date: Fri, 5 Dec 2025 09:31:24 +0000 Subject: [PATCH] Enhance README with project description and requirements Updated README to provide project details and usage instructions. --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6c4330c..bf8002d 100644 --- a/README.md +++ b/README.md @@ -1 +1,11 @@ -"# Video_Game_Mini_Maps" +Code used to create a video game style mini map as featured in the Garage Tinkering video at https://youtu.be/sAp7oCB939c + +Designed for a Waveshare ESP32-P4 3.4", but should work on the 4" exactly the same by updating the config to the correct board. + +Requires offline maps provided as a tiled grid of .bin images on an SDCard - recommended zoom level 16 +Default structure: `tiles1/z/x/y.bin` + +Demo uses an externally provided GPS location via CANBus ID 0x430. If needed you could be able to add via serial directly to the board. + +Code is free to use and modify as you like, but not for commercial +CC BY-NC (Attribution-NonCommercial)