クイックスタート

Playground を使う

Playground でサンプルを選び、「静的ネットを検証済み」と表示されるまで待ちます。接続を編集すると検証と図の更新が行われます。全体表示、拡大・縮小、スクロールで挿入ガイドを確認してください。

SVG のダウンロードは現在のソースが有効なときだけ使えます。エラー時は最後に成功した図を「最後に成功したプレビュー」として残しますが、修正するまでダウンロードはできません。再読み込み前に編集したソースを別の場所へコピーしてください。

English / 日本語で UI 言語を切り替えます。DSL の識別子と出力 SVG は変わりません。日本語の診断には説明に加えて、元のコンパイラーの詳細も表示します。

ソースから実行する

サーバーが表示するローカル HTTP アドレスを開いてください。index.html をファイルとして直接開く方法では、必要な HTTP・モジュール Worker 環境を利用できません。npm メタデータは private で、インストール可能なパッケージとしては未公開です。

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

CLI で検証・描画する

check は構文、意味、配置、物理ネットリストを検証します。render はさらに配線経路の探索と SVG 生成を行うため、check 成功後でも経路のエラーで失敗する場合があります。

生成 SVG には Arduino 由来のイラストの出典情報が含まれます。共有時はメタデータと表示上のクレジットを保持してください。「ライセンス」を参照してください。

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