Skip to content

Commit 813bb8f

Browse files
Update README.md (#92)
1 parent b5f7e8c commit 813bb8f

File tree

1 file changed

+33
-18
lines changed

1 file changed

+33
-18
lines changed

README.md

Lines changed: 33 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,36 +9,39 @@
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-
16-
This library is **PlatformIO only** due to use of modern C++ features. The Arduino IDE is **not** supported.
17-
Use [the latest Arduino ESP32 Core version](https://github.com/pioarduino/platform-espressif32/releases/latest) from [pioarduino](https://github.com/pioarduino/platform-espressif32) to compile this library.
18-
1912
[![map](https://github.com/user-attachments/assets/39a7f287-c59d-4365-888a-d4c3f77a1dd1 "Click to visit OpenStreetMap.org")](https://www.openstreetmap.org/)
2013

21-
The returned map can be pushed to the screen, saved to SD or used for further composing.
14+
A map is composed from downloaded OSM tiles and returned as a LGFX sprite.
15+
Tile fetching and decoding is performed concurrently across both cores on dualcore ESP32 devices.
16+
A composed map can be pushed to the screen, saved to SD or used for further composing.
2217
Downloaded tiles are cached in psram for reuse.
2318

2419
This library should work on any ESP32 type with psram and a LovyanGFX compatible display.
25-
OSM tiles are quite large -128kB per tile- so psram is required.
20+
OSM tiles are quite large -128kB per tile- so psram is required.
2621

27-
This project is not endorsed by or affiliated with the OpenStreetMap Foundation.
22+
This project is not endorsed by or affiliated with the OpenStreetMap Foundation.
23+
Use of any OSMF provided service is governed by the [OSMF Terms of Use](https://osmfoundation.org/wiki/Terms_of_Use).
2824

29-
## License differences between this library and the map data
25+
## How to use
3026

31-
### This library has a MIT license
27+
This library is **PlatformIO only** due to use of modern C++ features. The Arduino IDE is **not** supported.
28+
Use [the latest Arduino ESP32 Core version](https://github.com/pioarduino/platform-espressif32/releases/latest) from [pioarduino](https://github.com/pioarduino/platform-espressif32) to compile this library.
29+
See the example PIO settings and example code to get started.
3230

33-
The `OpenstreetMap-esp32` library -this library- is licensed under the [MIT license](/LICENSE).
31+
### Example `platformio.ini` settings
3432

35-
### The downloaded tile data has a ODbL license
33+
These settings use `Arduino Release v3.2.0 based on ESP-IDF v5.4.1` from pioarduino.
3634

37-
OpenStreetMap® is open data, licensed under the [Open Data Commons Open Database License (ODbL)](https://opendatacommons.org/licenses/odbl/) by the OpenStreetMap Foundation (OSMF).
35+
```bash
36+
[env]
37+
platform = https://github.com/pioarduino/platform-espressif32/releases/download/53.03.20/platform-espressif32.zip
38+
framework = arduino
3839

39-
Use of any OSMF provided service is governed by the [OSMF Terms of Use](https://osmfoundation.org/wiki/Terms_of_Use).
40-
41-
## Functions
40+
lib_deps =
41+
celliesprojects/OpenStreetMap-esp32@^1.0.6
42+
lovyan03/LovyanGFX@^1.2.7
43+
https://github.com/bitbank2/PNGdec@^1.1.3
44+
```
4245

4346
### Set map size
4447

@@ -201,3 +204,15 @@ void loop()
201204
delay(1000);
202205
}
203206
```
207+
208+
## License differences between this library and the map data
209+
210+
### This library has a MIT license
211+
212+
The `OpenstreetMap-esp32` library -this library- is licensed under the [MIT license](/LICENSE).
213+
214+
### The downloaded tile data has a ODbL license
215+
216+
OpenStreetMap® is open data, licensed under the [Open Data Commons Open Database License (ODbL)](https://opendatacommons.org/licenses/odbl/) by the OpenStreetMap Foundation (OSMF).
217+
218+
Use of any OSMF provided service is governed by the [OSMF Terms of Use](https://osmfoundation.org/wiki/Terms_of_Use).

0 commit comments

Comments
 (0)