diff --git a/README.md b/README.md index 4af85f9..aa3859e 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,19 @@

## 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. +**svg2nametag-Ren** converts 2D SVG designs into 3D printable nametags. It automatically splits your design into separate files for different colors, making it easy to print multi-color nametags on printers like the Bambu Lab series. -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. Requires basic command line knowledge. -- **Web App (WASM) (You Are Here)**: 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. +For detailed setup and usage guides, please check out the **[Wiki](wiki/Home.md)**. -## Technical Specifications -Every model produced by the converter follows a precise set of dimensions to ensure consistency and professional-grade print results: +## Physical Dimensions +The program automatically scales all designs to these specific measurements for a consistent, professional look: -- **Automatic Scaling**: All nametags are normalized to a standard width of **87.80mm**, or **150%** scale. -- **Background Layer**: The background is set 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. (They end up at a coords 4mm.) -- **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. -- **Relatively Low Poly Count** Won't explode your slicer +- **Total Width**: 87.80 mm +- **Background Thickness**: 3.0 mm +- **Text/Detail Thickness**: 2.0 mm +- **Text/Detail Offset**: 3.0 mm (Text sits at 4mm from the bottom) +- **Total Height**: 5.0 mm (Text sits 3mm high and extends 2mm up) + +## Ways to Use +- **Web App**: The easiest way! Just open the web page, drag your files in, and download the results. No installation required. +- **Python Tool**: For advanced users who want to process hundreds of files at once using the command line. Requires Python 3.12 or higher and some basic knowledge of the command line.