Added README

This commit is contained in:
Robert 2021-04-18 19:36:14 +02:00
parent 7c814c591b
commit 3d3abacee8

16
README.md Normal file
View file

@ -0,0 +1,16 @@
# OSMParser
OSMParser is a C++ library for reading and parsing OSM XML data.
It uses tinyxml2 to read map data from a file and creates a C++ object to store all relevant data.
## OSMParser does
* extract all nodes, ways, relations from the XML file
* tag each node, way, relation accordingly
* make it easy to retrieve references (`nd`- and `member`-tags are stored as pointers)
## OSMParser does not
* render map data
* assemble relations like multipolygons
* query map data
To see OSMParser in action check out my [related project](https://github.com/Lauchmelder23/MapViewer)