@versatiles/svg-renderer 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 VersaTiles
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,63 @@
+# VersaTiles SVG Renderer
+
+Renders vector maps as SVG.
+
+![Example: rendered map view](docs/demo.svg)
+
+[Download SVG](docs/demo.svg)
+
+Currently only background, fill and line layers are supported.
+
+## E2E Visual Comparison
+
+A visual comparison report between the SVG renderer and MapLibre GL JS is published to GitHub Pages:
+
+[View Report](https://versatiles-org.github.io/versatiles-svg-renderer/report.html)
+
+## Dependency Graph
+
+<!--- This chapter is generated automatically --->
+
+```mermaid
+---
+config:
+  layout: elk
+---
+flowchart TB
+
+subgraph 0["src"]
+1["demo.ts"]
+2["index.ts"]
+subgraph 3["lib"]
+4["geometry.ts"]
+7["color.ts"]
+9["style_layer.ts"]
+end
+subgraph 5["processor"]
+6["render.ts"]
+8["styles.ts"]
+A["vector.ts"]
+B["helper.ts"]
+end
+subgraph C["renderer"]
+D["renderer_svg.ts"]
+end
+E["types.ts"]
+end
+1-->2
+2-->4
+2-->6
+2-->D
+6-->7
+6-->4
+6-->8
+6-->A
+8-->9
+A-->4
+A-->B
+B-->4
+D-->7
+
+class 0,3,5,C subgraphs;
+classDef subgraphs fill-opacity:0.1, fill:#888, color:#888, stroke:#888;
+```