mirror of
https://github.com/imjasonh/scad-to-png
synced 2026-07-07 01:22:23 +00:00
Update README with clearer project purpose and AI agent use case
- Add introduction explaining the tool bridges the gap between AI code generation and 3D understanding - Clarify the feedback loop concept for AI agents iterating on 3D designs - Keep all existing documentation while adding context about the tool's purpose 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
e7f9d1882f
commit
b14421fc19
1 changed files with 12 additions and 2 deletions
14
README.md
14
README.md
|
|
@ -1,6 +1,16 @@
|
|||
# scad-to-png
|
||||
|
||||
A CLI tool that converts OpenSCAD files to PNG images from multiple viewpoints without requiring OpenSCAD to be installed. This tool uses OpenSCAD WASM to convert .scad files to STL, then renders the STL to PNG images from 8 different angles.
|
||||
AI agents seem to be good at _generating code_, and even seem pretty good at _understanding two-dimensional pictures_ (PNG, JPG, GIF). They don't seem to be good at understanding 3D objects described in standard formats like STL. [OpenSCAD](https://openscad.org/) is a format for describing parametric 3D objects, and a tool to execute that code and generate STL files.
|
||||
|
||||
This project attempts to bridge the gap by providing a simple, relatively quick tool to execute code in a SCAD file, generate an STL, and generate a variety of PNGs of the resulting 3D object seem from a number of angles.
|
||||
|
||||
It aims to do this without requiring the relatively heavy-weight OpenSCAD tool to be installed, by instead relying on its WASM port, and a pure software STL-to-PNG renderer.
|
||||
|
||||
The idea is that, with some work, this tool could be used with AI agents to
|
||||
|
||||
1. generate OpenSCAD code
|
||||
2. generate STLs and PNGs that the AI agent can view and understand
|
||||
3. iterate toward some goal based on that feedback loop
|
||||
|
||||
## Features
|
||||
|
||||
|
|
@ -154,4 +164,4 @@ This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENS
|
|||
## Acknowledgments
|
||||
|
||||
- OpenSCAD team for the WebAssembly port
|
||||
- The OpenSCAD Playground project for inspiration on WASM usage
|
||||
- The OpenSCAD Playground project for inspiration on WASM usage
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue