diff --git a/README.md b/README.md index b91464d..11d204c 100644 --- a/README.md +++ b/README.md @@ -9,17 +9,19 @@ This library provides a [OpenStreetMap](https://www.openstreetmap.org/) (OSM) map fetching and tile caching system for ESP32-based devices. Under the hood it uses [LovyanGFX](https://github.com/lovyan03/LovyanGFX) and [PNGdec](https://github.com/bitbank2/PNGdec) to do the heavy lifting. +A map is composed from downloaded OSM tiles and returned as a LGFX sprite. + +Tile fetching and decoding is performed concurrently across both cores on dualcore ESP32 devices. + This library is **PlatformIO only** due to use of modern C++ features. The Arduino IDE is **not** supported. [![map](https://github.com/user-attachments/assets/39a7f287-c59d-4365-888a-d4c3f77a1dd1 "Click to visit OpenStreetMap.org")](https://www.openstreetmap.org/) -A map is composed from downloaded OSM tiles and returned as a LGFX sprite. -The sprite can be pushed to the screen, saved to SD or used for further composing. +The returned map can be pushed to the screen, saved to SD or used for further composing. Downloaded tiles are cached in psram for reuse. This library should work on any ESP32 type with psram and a LovyanGFX compatible display. OSM tiles are quite large -128kB per tile- so psram is required. -Tile fetching and decoding is performed concurrently across both cores on multicore ESP32 devices. This project is not endorsed by or affiliated with the OpenStreetMap Foundation. @@ -29,7 +31,7 @@ This project is not endorsed by or affiliated with the OpenStreetMap Foundation. The `OpenstreetMap-esp32` library -this library- is licensed under the [MIT license](/LICENSE). -### The downloaded tile data has a Open Data Commons Open Database License (ODbL) +### The downloaded tile data has a ODbL license OpenStreetMapĀ® is open data, licensed under the [Open Data Commons Open Database License (ODbL)](https://opendatacommons.org/licenses/odbl/) by the OpenStreetMap Foundation (OSMF). @@ -199,11 +201,3 @@ void loop() } ``` -### PlatformIO setup - -```bash -lib_deps = - celliesprojects/OpenStreetMap-esp32@^1.0.3 - lovyan03/LovyanGFX@^1.2.0 - bitbank2/PNGdec@^1.0.3 -```