From 11f0464ceec2f667b5a778fd33db027587edf9eb Mon Sep 17 00:00:00 2001 From: unfunny Date: Sat, 14 Feb 2026 19:47:18 -0500 Subject: [PATCH] add readme (thx gemini) --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9ca1957 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# svg2nametag-Ren + +

+ Logo +

+ +## Overview +**svg2nametag-Ren** is a specialized toolset designed to convert 2D SVG designs into 3D printable nametag models (STL). It specifically handles multi-material or multi-color 3D prints by automatically separating SVG layers into distinct STL files optimized for Bambu Studio, OrcaSlicer, or PrusaSlicer. + +The project offers two primary ways to work: +- **Python CLI**: A robust command-line interface for bulk-processing entire directories of SVGs on your local machine. +- **Web App (WASM)**: A high-performance, client-side web application powered by Manifold 3D. It runs entirely in the browser, supports batch folder uploads, and works offline as a PWA. + +## Technical Specifications +Every model produced by the converter follows a precise set of dimensions to ensure consistency and professional-grade print results: + +- **Automatic Scaling**: All nametags are normalized to a standard width of **87.80mm**. +- **Background Layer**: The base layer is extruded to a thickness of **3.0mm**. +- **Text/Graphic Layers**: Primary and accent layers are extruded to a height of **2.0mm**. +- **Optimized Offsets**: Text layers are offset by **3.0mm** along the Z-axis, ensuring they sit perfectly on top of the background. +- **Hole Handling**: Implements a robust **Even-Odd** fill rule to correctly render internal contours in complex typography (e.g., the centers of 'B', 'O', or 'R'). +- **Layer Classification**: Recognizes SVG classes (`st1`, `st2`) to split designs into separate STL components for easy filament assignment.