-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the documentation hub for material-layout-planner, a local, browser-only app for planning how rectangular materials are laid out across measured 2D surfaces.
This wiki holds the long-form documentation for every feature in the application. The README in the source repository remains the quick-start; everything else lives here.
Each entry below maps one-to-one with a feature bullet in the project README. Click through for the deep dive.
| Feature | Page |
|---|---|
| 🖊️ Accurate 2D drawing with real dimensions, grid, and snapping | [[2D Drawing Tools |
| 🧩 Named surfaces, openings, and multi-surface connections | [[Surfaces, Openings & Connections |
| 🎨 Material library with size, thickness, joints, and styles | [[Material Library |
| 🔁 Placement patterns (stacked, running bond, custom offsets, …) | [[Placement Patterns |
| 🪚 Auto-generated cut lists, cutting diagrams, and waste reports | [[Cut Lists & Layouts |
| [[Edge Overlap Visualization | |
| 🖼️ Background image import with two-point calibration | [[Background Image Calibration |
| 💾 Local project storage + JSON import/export | [[Local Storage & JSON |
| 📄 One-click PDF export with technical drawings and instructions | [[PDF Export |
-
App source —
fihorvat/material-layout-planner -
Wiki source —
fihorvat/material-layout-planner.wiki(this repo) - Issues / Discussions — GitHub Issues
All commit messages in this wiki follow the
Conventional Commits specification
and are enforced locally by commitlint + husky (mirroring the main
repository). After cloning, run npm install once to wire up the
commit-msg hook.
If you change the application, you also need to update the wiki — see
AGENTS.md in the main repository for the agent-level rules.
Documentation for the material-layout-planner project. Every feature in the application is documented here — see the contribution rules before opening a pull request.