diff --git a/README.md b/README.md index ffe40b8..b91464d 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,13 @@ [![Release](https://img.shields.io/github/v/release/CelliesProjects/OpenStreetMap-esp32)](https://github.com/CelliesProjects/OpenStreetMap-esp32/releases/latest) [![Issues](https://img.shields.io/github/issues/CelliesProjects/OpenStreetMap-esp32)](https://github.com/CelliesProjects/OpenStreetMap-esp32/issues) [![PlatformIO](https://img.shields.io/badge/PlatformIO-Compatible-green?logo=platformio)](https://registry.platformio.org/libraries/celliesprojects/openstreetmap-esp32) -[![arduino-library-badge](https://www.ardu-badge.com/badge/OpenStreetMap-esp32.svg?)](https://docs.arduino.cc/libraries/openstreetmap-esp32/) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/0961fc2320cd495a9411eb391d5791ca)](https://app.codacy.com/gh/CelliesProjects/OpenStreetMap-esp32/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) 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. +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. @@ -202,7 +203,7 @@ void loop() ```bash lib_deps = - celliesprojects/OpenStreetMap-esp32@^1.0.2 + celliesprojects/OpenStreetMap-esp32@^1.0.3 lovyan03/LovyanGFX@^1.2.0 bitbank2/PNGdec@^1.0.3 ``` diff --git a/library.json b/library.json new file mode 100644 index 0000000..86342d0 --- /dev/null +++ b/library.json @@ -0,0 +1,42 @@ +{ + "name": "OpenStreetMap-esp32", + "version": "1.0.3", + "description": "This library provides a OpenStreetMap (OSM) map fetching and caching system for ESP32-based devices.", + "keywords": [ + "OpenStreetMap", + "GPS", + "LovyanGFX", + "ESP32" + ], + "repository": { + "type": "git", + "url": "https://github.com/CelliesProjects/OpenStreetMap-esp32" + }, + "authors": [ + { + "name": "CelliesProjects" + } + ], + "frameworks": [ + "arduino" + ], + "platforms": [ + "espressif32" + ], + "dependencies": [ + { + "name": "LovyanGFX", + "version": "https://github.com/lovyan03/LovyanGFX.git#1.2.7" + }, + { + "name": "PNGdec", + "version": "https://github.com/bitbank2/PNGdec.git#28b221d" + } + ], + "build": { + "flags": [ + "-std=gnu++17" + ] + }, + "license": "MIT" +} \ No newline at end of file diff --git a/library.properties b/library.properties deleted file mode 100644 index d3ea1a6..0000000 --- a/library.properties +++ /dev/null @@ -1,11 +0,0 @@ -name=OpenStreetMap-esp32 -version=1.0.2 -author=Cellie -maintainer=Cellie -sentence=A library to display OpenStreetMap maps on ESP32 devices. -paragraph=This library allows you to fetch and display OpenStreetMap tiles on ESP32-based devices with a display. It supports caching, zooming, and saving maps to SD card. -category=Display -url=https://github.com/CelliesProjects/OpenStreetMap-esp32 -architectures=esp32 -includes=OpenStreetMap-esp32.h -depends=LovyanGFX, PNGdec