Skip to content

Commit bcbf692

Browse files
Update README.md
1 parent f069632 commit bcbf692

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,10 @@ A map is composed from downloaded OSM tiles and returned as a LGFX sprite.
1313
The sprite can be pushed to the screen or used for further composing.
1414
Downloaded tiles are cached in psram for reuse.
1515

16-
The library should work on any ESP32 type with psram and a LovyanGFX compatible display.
16+
This library should work on any ESP32 type with psram and a LovyanGFX compatible display.
17+
The downloaded tile cache gets large very quickly -128kB per tile- so psram is required.
1718

18-
The downloaded tile cache gets large very quickly -128kB per tile- so a ESP32 with psram is required.
19+
This project is not endorsed by or affiliated with the OpenStreetMap Foundation.
1920

2021
### Functions
2122

@@ -63,12 +64,14 @@ bool saveMap(const char *filename, LGFX_Sprite &map, String &result,
6364
- `sdPin` is **optional** and used to set a `SS/CS` pin for the SD slot.
6465
- `frequency` is **optional** and used to set the SD speed.
6566

67+
**Note**: The SD card is managed from `begin()` to `end()` inside the `saveMap()` function.
68+
Do not mount the SD card before this function but unmount if it is mounted else memory will be leaked.
69+
6670
## License differences between this library and the map data
6771

6872
### This library has a MIT license
6973

7074
The `OpenstreetMap-esp32` library -this library- is licensed under the [MIT license](/LICENSE).
71-
This project is not endorsed by or affiliated with the OpenStreetMap Foundation.
7275

7376
### The downloaded tile data has a Open Data Commons Open Database License (ODbL)
7477

0 commit comments

Comments
 (0)