Skip to content

Commit 8fc1361

Browse files
Update README.md (#66)
1 parent 928a4cd commit 8fc1361

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

README.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,19 @@
99
This library provides a [OpenStreetMap](https://www.openstreetmap.org/) (OSM) map fetching and tile caching system for ESP32-based devices.
1010
Under the hood it uses [LovyanGFX](https://github.com/lovyan03/LovyanGFX) and [PNGdec](https://github.com/bitbank2/PNGdec) to do the heavy lifting.
1111

12+
A map is composed from downloaded OSM tiles and returned as a LGFX sprite.
13+
14+
Tile fetching and decoding is performed concurrently across both cores on dualcore ESP32 devices.
15+
1216
This library is **PlatformIO only** due to use of modern C++ features. The Arduino IDE is **not** supported.
1317

1418
[![map](https://github.com/user-attachments/assets/39a7f287-c59d-4365-888a-d4c3f77a1dd1 "Click to visit OpenStreetMap.org")](https://www.openstreetmap.org/)
1519

16-
A map is composed from downloaded OSM tiles and returned as a LGFX sprite.
17-
The sprite can be pushed to the screen, saved to SD or used for further composing.
20+
The returned map can be pushed to the screen, saved to SD or used for further composing.
1821
Downloaded tiles are cached in psram for reuse.
1922

2023
This library should work on any ESP32 type with psram and a LovyanGFX compatible display.
2124
OSM tiles are quite large -128kB per tile- so psram is required.
22-
Tile fetching and decoding is performed concurrently across both cores on multicore ESP32 devices.
2325

2426
This project is not endorsed by or affiliated with the OpenStreetMap Foundation.
2527

@@ -29,7 +31,7 @@ This project is not endorsed by or affiliated with the OpenStreetMap Foundation.
2931

3032
The `OpenstreetMap-esp32` library -this library- is licensed under the [MIT license](/LICENSE).
3133

32-
### The downloaded tile data has a Open Data Commons Open Database License (ODbL)
34+
### The downloaded tile data has a ODbL license
3335

3436
OpenStreetMap® is open data, licensed under the [Open Data Commons Open Database License (ODbL)](https://opendatacommons.org/licenses/odbl/) by the OpenStreetMap Foundation (OSMF).
3537

@@ -199,11 +201,3 @@ void loop()
199201
}
200202
```
201203

202-
### PlatformIO setup
203-
204-
```bash
205-
lib_deps =
206-
celliesprojects/OpenStreetMap-esp32@^1.0.3
207-
lovyan03/LovyanGFX@^1.2.0
208-
bitbank2/PNGdec@^1.0.3
209-
```

0 commit comments

Comments
 (0)