Watch

History

Repository files (latest commit first)
Filename	Latest commit message	Latest commit date
Istvan Matejcsok c5b4561495 docs+test(wasm): Part 2 as-built record; cross-face probe spec - docs/features/editor-unification/06-part2-implementation.md — the merged kicad_editor as-built record: symbol-collision surgery (incl. the 21-symbol ODR audit), embind dispatcher, wiring, and validation results (frame-runtime 4/4, full suite 67 passed / 1 known pre-existing 3d-viewer drag failure fixed on main by `7630c7e`, collab 10/10, cross-face probe green). README status/index updated; dangling perf/bundle-size.md links → perf/README.md. - tests/kicad/xface-probe.spec.ts — permanent cross-face guard: a --frame=sch session opens Preferences and asserts the PCB engine's pages ("PCB Editor", "Footprint Editor") exist — i.e. KiFACE(FACE_PCB) lazy-starts inside a schematic session (absent on single-kiface bundles). Routed to BIG_MODULE_SPECS. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>		2026-07-02 17:56:02 +02:00
..
debugging	docs: ✏️ cleanup and organize docs	2026-06-05 12:16:13 +02:00
features	docs+test(wasm): Part 2 as-built record; cross-face probe spec	2026-07-02 17:56:02 +02:00
research	docs: ✏️ cleanup and organize docs	2026-06-05 12:16:13 +02:00
build.md	refactor: collapse dual-mode plumbing — the DOM port is the only WASM build	2026-06-12 20:19:48 +02:00
ci-build-slowness-findings.md	docs: CI build perf findings + parked wasm-exceptions experiment	2026-06-11 07:50:57 +02:00
README.md	docs: ✏️ cleanup and organize docs	2026-06-05 12:16:13 +02:00
wasm-exceptions-experiment.md	feat(wasm-eh): migrate the WASM build to native wasm exceptions (+ 3D viewer default-on)	2026-06-30 09:40:26 +02:00

README.md

Documentation Map

A central index of the documentation in this repo. The goal of the project is to build KiCad with WASM and run it in a browser.

Note: per-area README.md files stay next to the code they describe (they're linked below). Cross-cutting guides live under docs/. Per-feature design notes live under features/.

Start here

Project README — overview, prerequisites, quick start, project structure
CLAUDE.md — project/agent context and contribution conventions

Build

docs/build.md — Docker-based KiCad WASM build system (two-phase build, outputs, memory)
docker/README.md — Docker build environment, branch-specific containers, troubleshooting
wasm/README.md — WASM compatibility layer (overrides/shims without patching KiCad)

Debugging & Asyncify

docs/debugging/DEBUG.md — debugging guide: Asyncify stalls vs crashes, shim/codegen coupling, stub-bisection
docs/debugging/learning.md — Asyncify + consecutive modal dialogs: the lock pattern
docs/research/threading_1.md — deep dive: the Asyncify single-slot currData collision bug and the fix
docs/research/threading_2.md — external research: JSPI/WasmFX/state-machine alternatives, QEMU analysis

Architecture

wasm/README.md — WASM compatibility layer structure
web/README.md — web app (create/open KiCad projects), tech stack, URL routing, WASM artifact serving

Testing

tests/README.md — Playwright test infrastructure, element registry, logs, screenshots
tests/WHATWORKS.md — wxWidgets-in-WASM feature coverage matrix and KiCad readiness
tests/GL_README.md — Emscripten legacy GL immediate-mode quirks (color-per-vertex)
tests/gal-regression/README.md — GAL visual regression suite (native OpenGL vs WebGL WASM)

Feature design docs

Per-feature design notes and porting records live under features/:

web-init — web app spec
schematic — eeschema WASM bring-up
symbol-editor — symbol editor (eeschema kiface launcher)
gerbview — Gerber viewer port
pl-editor — page-layout editor port (incl. file-dialog usability fixes)
browser-tools — tool-activation / coroutine deep dives
fix-asyncify-O2-and-modal-promise-rejection — RTree wasm overflow bug investigation

Archived / historical

features/archive/ holds docs whose work is done or superseded (each carries a status banner):

webgl — WebGL-GAL strategy/plan (since implemented in kicad/common/gal/webgl/)
ipc-api — IPC-API guard cleanup TODO (revert not yet actioned)