Quickstart

Use the Playground

Open the Playground, choose a sample and wait for “static nets verified”. Edit a connection to see validation and a new diagram. Use Fit, zoom and scrolling to inspect the insertion guide.

Download SVG is enabled only for the current valid source. After an error, the previous drawing stays visible with a stale label and cannot be downloaded until the source is valid again. Copy edited source somewhere safe before reloading.

Use the English / 日本語 selector for UI language. DSL identifiers and exported diagrams remain unchanged. Japanese diagnostics include guidance and preserve the original compiler detail.

Run from source

Use the local HTTP address printed by the server. Opening index.html as a file does not provide the HTTP/module-worker environment the app requires. The project is private in npm metadata and is not an installable published package.

git clone https://github.com/yuto90/bread.git
cd bread
nvm install
nvm use
npm ci --ignore-scripts
npm run playground

Check and render

check runs parsing, semantic validation, placement and physical netlist verification. render additionally routes wires and creates SVG. A routing error can therefore occur after check succeeds.

The generated SVG contains Arduino-derived illustration attribution. Keep that metadata and the visible credit when sharing it; see Licensing.

node src/cli.ts check examples/blink.bread
node src/cli.ts render examples/blink.bread -o output/blink.svg