diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..8ec0c2e9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Questions and chat + url: https://discord.gg/FtU4NQNVDH + about: Ask questions and talk with users and contributors on the SolidCraft Discord. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b835ed41..7e9fcc8c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,8 @@ Help is welcome, whether that's a one-line fix or owning a whole area. This page build it, how the code is laid out, the few rules that aren't negotiable, and where help is needed most. +Questions, ideas or want to say what you're working on? Join the [Discord](https://discord.gg/FtU4NQNVDH). + ## Get it running (about 10 minutes on a fast machine) You need stable Rust 1.95 or newer (required by egui/eframe 0.36). For the web diff --git a/README.md b/README.md index f24a498d..b7d69b32 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,17 @@ -# SolidCraft +

+ SolidCraft +

-**An open-source parametric 3D CAD application built in pure Rust.** +

SolidCraft

-Sketch, constrain, and build solids with a parametric feature timeline. Change a dimension -and watch your model rebuild. Run it on your desktop, in your browser, or let AI agents -model through the built-in MCP server. +

+ An open-source parametric 3D CAD application built in pure Rust.
+ Sketch, constrain, and build solids with a parametric feature timeline. Change a dimension + and watch your model rebuild. Run it on your desktop, in your browser, or let AI agents + model through the built-in MCP server. +

-![SolidCraft 0.8: model a Raspberry Pi 4 case from an empty design: a sketch dimensioned with parameters, extrude, fillets and shell, a rim rounded in one pick, standoffs patterned on the board's mounting holes, port cut-outs, vent slots, "Pi 4" engraved in a font, a PETG material with its mass in Properties, and a height change in Parameters](docs/screenshots/demo-0.8.gif) - -*A Raspberry Pi 4 case from an empty design: a sketch dimensioned with the board's parameters, extrude, fillet, shell, the rim rounded in one pick, an M2.5 standoff patterned on the 58 × 49 mm hole rectangle, port cut-outs, vent slots, "Pi 4" engraved in DejaVu Sans Bold and a PETG material defined in the design, with its mass in Properties, then height 24 → 32 mm in Parameters and it all rebuilds. 9× playback. [Full video](https://github.com/bherbruck/solidcraft/raw/refs/heads/main/docs/screenshots/demo-0.8.mp4), recorded with the [demo script](examples/demo/record_ui.sh).* - -## Download +
[![Download for Windows][badge-windows]][windows-msi] [![Download for macOS][badge-macos]][macos-dmg] @@ -18,6 +19,31 @@ model through the built-in MCP server. [![Get it from the Snap Store][badge-snap]][snap-store] [![Try it in your browser][badge-web]][web-app] +
+ +

+ Download · + Try it in the browser · + Documentation · + Discord · + SolidCore +

+ +

+ CI + Latest release + Downloads + Licence + Discord + Stars +

+ +![SolidCraft 0.8: model a Raspberry Pi 4 case from an empty design: a sketch dimensioned with parameters, extrude, fillets and shell, a rim rounded in one pick, standoffs patterned on the board's mounting holes, port cut-outs, vent slots, "Pi 4" engraved in a font, a PETG material with its mass in Properties, and a height change in Parameters](docs/screenshots/demo-0.8.gif) + +*A Raspberry Pi 4 case from an empty design: a sketch dimensioned with the board's parameters, extrude, fillet, shell, the rim rounded in one pick, an M2.5 standoff patterned on the 58 × 49 mm hole rectangle, port cut-outs, vent slots, "Pi 4" engraved in DejaVu Sans Bold and a PETG material defined in the design, with its mass in Properties, then height 24 → 32 mm in Parameters and it all rebuilds. 9× playback. [Full video](https://github.com/bherbruck/solidcraft/raw/refs/heads/main/docs/screenshots/demo-0.8.mp4), recorded with the [demo script](examples/demo/record_ui.sh).* + +## Download + - **Windows:** download and run the [installer][windows-msi]. Also for [ARM64][windows-arm64-msi] and [32-bit][windows-x86-msi] PCs, or as a [portable zip][windows-portable] that runs without installing. @@ -62,6 +88,8 @@ Install details, upgrading from earlier builds and building from source are in **Documentation:** the [SolidCraft book](https://bherbruck.github.io/solidcraft/) (user guide, developer guide and command reference; sources in [docs/book](docs/book)). +**Community:** chat with users and contributors on [Discord](https://discord.gg/FtU4NQNVDH). + **Status: early but usable for simple parts.** 75 of 76 public reference parts match their analytic or FreeCAD-computed volume, area, centre of mass and bounding box ([docs/oracle.md](docs/oracle.md)); the other is a tracked bug.