Skip to content

docs: refresh README + docs status for v0.5.0 #287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sobechestnut-dev merged 1 commit into from
Aug 14, 2026
Merged

docs: refresh README + docs status for v0.5.0 #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,17 @@ intermediate representation (`ToolpathIR`), and render an interactive Three.js (
Canvas 2D) preview — with first-class **Vue, React, Svelte, and a framework-neutral Web Component**
integrations that are thin adapters over one shared engine.

> **Status: published.** Thirteen `@chestnutlabs/*` packages are on npm (latest **`v0.4.0`**,
> **Status: published.** Thirteen `@chestnutlabs/*` packages are on npm (latest **`v0.5.0`**,
> lockstep-versioned with npm provenance). E0–E11 of the
> [master plan](docs/00_PROJECT_MASTER_PLAN.md) are closed; **`v0.4.0` adds non-extrusion toolpaths —
> CNC / laser / plotter**: `MoveKind.Cut` classification, an opt-in modal `toolPower` (laser power /
> spindle RPM) channel, canned drilling-cycle expansion (`G81`/`G82`/`G83`), evidence-based controller
> recognition (GRBL laser/mill, LinuxCNC) with **validation tiers** (GRBL-laser hardware-validated),
> power / cut-vs-rapid color modes, and toolpath STL export — all honesty-tiered, with FDM output
> byte-identical. Install from npm — see *Quick start* below.
> [master plan](docs/00_PROJECT_MASTER_PLAN.md) are closed. **`v0.5.0`** adds camera controls — **preset
> views + a serializable camera-state API** (`setView`/`getCameraState`/`setCameraState`, declarative
> `view`/`cameraState` props, zoom-to-cursor, keyboard-operable camera) — and surfaces `capabilities` /
> `warnings` on the `ready` event. **`v0.4.0`** added non-extrusion toolpaths — CNC / laser / plotter:
> `MoveKind.Cut` classification, an opt-in modal `toolPower` channel, canned drilling-cycle expansion
> (`G81`/`G82`/`G83`), evidence-based controller recognition (GRBL laser/mill, LinuxCNC) with
> **validation tiers** (GRBL-laser hardware-validated), power / cut-vs-rapid color modes, and toolpath
> STL export — all honesty-tiered, with FDM output byte-identical. Install from npm — see *Quick start*
> below.

![3DBenchy rendered as tubes with feature coloring in the showcase viewer](docs/media/viewer-benchy-tubes.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ See also [`../PROJECT_SETUP.md`](../PROJECT_SETUP.md) for the local environment
Provenance of inherited vs. Chestnut code, the exact founding baseline, and the branch mapping are
tracked in [`UPSTREAM_PROVENANCE.md`](UPSTREAM_PROVENANCE.md).

## Current state (updated 2026-07-29 — **v0.4.0 shipped to npm** (13 lockstep pkgs); #188 bgcode closed; #189 CNC/laser phases 1–5 + real-file lexer/detection, G0-rapid fix, GRBL-laser hardware-validated, #152 STL export done; DD-017 RS274NGC parametric programs proposed)
## Current state (updated 2026-08-14 — **v0.5.0 shipped to npm** (13 lockstep pkgs): camera preset-views + serializable `CameraState` API, zoom-to-cursor, keyboard-a11y, `capabilities`/`warnings` on `ready`, Svelte `buildVolume` fix, docs/demo/CNC-test hardening (epic #279). v0.4.0 shipped 2026-08-01 (#189 CNC/laser: lexer/detection, GRBL-laser hardware-validated, STL). DD-017 RS274NGC parametric programs proposed, unbuilt)

| Epic | Status | Gate |
|---|---|---|
Expand Down
Loading