diff --git a/README.md b/README.md index edc9a2c..e630753 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,20 @@ -# OSM Maker +# osm-maker-vibes -Convert OpenStreetMap data to 3D models. +> Warning: Experimental, incomplete, and unfunded. + +
+
+
+Generates a GLB file from OSM data for the configured area. +
## Usage ```bash +# 1. configure ./config.jsonc +# 2. generate the glb ./gradlew run -``` - -Generates a GLB file from OSM data for the configured area. \ No newline at end of file +``` \ No newline at end of file diff --git a/osm-maker-vibes.png b/osm-maker-vibes.png new file mode 100644 index 0000000..792729c Binary files /dev/null and b/osm-maker-vibes.png differ