Skip to content

Commit f2c51c9

Browse files
Change to PlatformIO project (#63)
* Change to PlatformIO project * Bump version to 1.0.3 * Update version in README.md
1 parent 0d4bebb commit f2c51c9

File tree

3 files changed

+45
-13
lines changed

3 files changed

+45
-13
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@
44
[![Release](https://img.shields.io/github/v/release/CelliesProjects/OpenStreetMap-esp32)](https://github.com/CelliesProjects/OpenStreetMap-esp32/releases/latest)
55
[![Issues](https://img.shields.io/github/issues/CelliesProjects/OpenStreetMap-esp32)](https://github.com/CelliesProjects/OpenStreetMap-esp32/issues)
66
[![PlatformIO](https://img.shields.io/badge/PlatformIO-Compatible-green?logo=platformio)](https://registry.platformio.org/libraries/celliesprojects/openstreetmap-esp32)
7-
[![arduino-library-badge](https://www.ardu-badge.com/badge/OpenStreetMap-esp32.svg?)](https://docs.arduino.cc/libraries/openstreetmap-esp32/)
87
[![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)
98

109
This library provides a [OpenStreetMap](https://www.openstreetmap.org/) (OSM) map fetching and tile caching system for ESP32-based devices.
1110
Under the hood it uses [LovyanGFX](https://github.com/lovyan03/LovyanGFX) and [PNGdec](https://github.com/bitbank2/PNGdec) to do the heavy lifting.
1211

12+
This library is **PlatformIO only** due to use of modern C++ features. The Arduino IDE is **not** supported.
13+
1314
[![map](https://github.com/user-attachments/assets/39a7f287-c59d-4365-888a-d4c3f77a1dd1 "Click to visit OpenStreetMap.org")](https://www.openstreetmap.org/)
1415

1516
A map is composed from downloaded OSM tiles and returned as a LGFX sprite.
@@ -202,7 +203,7 @@ void loop()
202203

203204
```bash
204205
lib_deps =
205-
celliesprojects/OpenStreetMap-esp32@^1.0.2
206+
celliesprojects/OpenStreetMap-esp32@^1.0.3
206207
lovyan03/LovyanGFX@^1.2.0
207208
bitbank2/PNGdec@^1.0.3
208209
```

library.json

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{
2+
"name": "OpenStreetMap-esp32",
3+
"version": "1.0.3",
4+
"description": "This library provides a OpenStreetMap (OSM) map fetching and caching system for ESP32-based devices.",
5+
"keywords": [
6+
"OpenStreetMap",
7+
"GPS",
8+
"LovyanGFX",
9+
"ESP32"
10+
],
11+
"repository": {
12+
"type": "git",
13+
"url": "https://github.com/CelliesProjects/OpenStreetMap-esp32"
14+
},
15+
"authors": [
16+
{
17+
"name": "CelliesProjects"
18+
}
19+
],
20+
"frameworks": [
21+
"arduino"
22+
],
23+
"platforms": [
24+
"espressif32"
25+
],
26+
"dependencies": [
27+
{
28+
"name": "LovyanGFX",
29+
"version": "https://github.com/lovyan03/LovyanGFX.git#1.2.7"
30+
},
31+
{
32+
"name": "PNGdec",
33+
"version": "https://github.com/bitbank2/PNGdec.git#28b221d"
34+
}
35+
],
36+
"build": {
37+
"flags": [
38+
"-std=gnu++17"
39+
]
40+
},
41+
"license": "MIT"
42+
}

library.properties

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)