added README file to describe usage of mapping files

OvertureMaps · Dec 12, 2023 · 91df02b · 91df02b
1 parent 3c2e2cf
commit 91df02b
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/task-force-docs/buildings/README.md b/task-force-docs/buildings/README.md
@@ -0,0 +1,14 @@
+# Description of the mappings file
+## facadeMaterial OSM mapping
+`overture_facadeMaterial_OSM_mapping.json` file contains mapping of OSM values to Overture `facedMaterial` property. OSM tags used for mapping in order:
+- `building:material` (documentation: https://wiki.openstreetmap.org/wiki/Key:building:material)
+- `building:facade:material` (documentation: https://wiki.openstreetmap.org/wiki/Key:building:facade:material)
+
+## roofMaterial OSM mapping
+`overture_roofMaterial_OSM_mapping.json` file contains mapping of OSM values to Overture `roofMaterial` property. OSM tags used for mapping:
+- `roof:material` (documentation: https://wiki.openstreetmap.org/wiki/Key:roof:material)
+
+## roofShape OSM mapping
+`overture_roofShape_OSM_mapping.json` file contains mapping of OSM values to Overture `roofShape` property. OSM tags used for mapping in order:
+- `roof:shape` (documentation: https://wiki.openstreetmap.org/wiki/Key:roof:shape)
+- `building:roof:shape` (deprecated, documentation: https://wiki.openstreetmap.org/wiki/Key:building:roof:shape)