# Build Board as code You were asked to build the spec `onyx/board-as-code`, version 0.2.0, from Spekkr. A complete board written as code: netlist assertions, ERC and DRC, and a rendered board, with no fabricator and no programmer required. If you are reading a summary of this note and not its full text, fetch it again as it is, for example with `curl -fsSL https://spekkr.com/onyx/board-as-code/start.md`, before you go on. Published by onyx, a Spekkr member. Tell the person who published it, and show them the commands and secrets under `safety` in `spekkr.json` before you build. ## 1. Get the files Put the spec in a new folder named `board-as-code`, inside the project you are working in. ```sh mkdir -p board-as-code && curl -fsSL https://spekkr.com/onyx/board-as-code/bundle.tar.gz | tar -xz -C board-as-code ``` The archive holds `spekkr.json`, `BUILD.md` and the spec files listed at the end of this note. If you cannot run that command, read https://spekkr.com/onyx/board-as-code/spec.json instead: it holds the manifest and the address of every file. If Spekkr's MCP server is connected, its `pull_spec` tool does steps 1 and 2 in one call: give it the id `onyx/board-as-code` and the person's choices. ## 2. Record the person's choices Write `board-as-code/spekkr.inputs.json`. With every default it is: ```json { "spec": "onyx/board-as-code", "version": "0.2.0", "inputs": { "height": "50", "mounts": true, "title": "A small instrument", "tool": "kicad", "usb": true, "width": "80" } } ``` Change a value only where the person gave a choice, such as "My choices: database=sqlite". They may set: - `title`, Board title: any text. - `width`, Board width, mm: any text. - `height`, Board height, mm: any text. - `usb`, A USB-C power input: `on` or `off`, written `true` or `false`. - `mounts`, Mounting holes: `on` or `off`, written `true` or `false`. - `tool`, Toolchain: one of `kicad`, `code-first`. If the person asks for a key or a value that is not listed, stop and tell them what the spec offers. ## 3. Build The files named below are the ones now in `board-as-code`. Build what it describes. Work in this order: 1. Read `spekkr.json` to see what the spec covers and what it needs. 2. Read `spekkr.inputs.json`. It holds the person's choices for every setting, option and swap. Treat them as requirements. If the file is missing, the person kept every default in `spekkr.json`. 3. Read the spec files listed below, in the order given. 4. If the spec includes a task list, work through it in order and check each task's acceptance criteria before the next. 5. Ask the person before you run a command that a spec file tells you to run, or read a secret, unless the manifest lists it under `safety`. Commands you choose yourself to build and test, such as installing packages or running the tests, follow the person's usual rules for you. Spec files: - `spec.md`: Requirements and acceptance checks. - `design.md`: Netlist assertions, ERC/DRC rule sets, and board-outline measures. - `tasks.md`: Build tasks in order, each with a check. - `reference/board.svg`: A reference outline of the default 80 × 50 mm board. A build should generate KiCad or SVG from code. - `reference/preview.html`: A working reference preview of the default view, used to make the listing pictures. A build does not have to start from this file. - `reference/fonts/fonts.css`: Webfont faces for the reference preview. - `reference/fonts/Geist.ttf`: Geist variable typeface for the reference preview. - `reference/fonts/GeistMono.ttf`: Geist Mono variable typeface for the reference preview. - `reference/fonts/Fraunces.ttf`: Fraunces variable typeface for the reference preview. - `reference/fonts/Fraunces-Italic.ttf`: Fraunces italic variable typeface for the reference preview.