breadkit-render 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3d7b06780f100a70e85853569136f7123912ce7708629d9d797f22190396c4f
+  data.tar.gz: beadb4b786adbe2b8250f0bc1a9fae04eab46eed4df6e011c0809cc5259070c3
+SHA512:
+  metadata.gz: e69e57aec01703ba0d6bdf4fe1c74228ee1b68f2c4dfb92f8e4c063e7294f31a1c423696710e43619bbf4ad6bd16476108bba24edc7657808f04b14783459d53
+  data.tar.gz: 8faa7a544c38cbe3ac009b82588d2eb9357810eccd891c27dcbd4a396a3d3a6de116f795dee9a257fdcba78b7b14426047a2fd8d21a15ba05ed9d803047ad2f8

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## Unreleased
+
+## 0.1.0 — 2026-09-27
+
+- Initial release.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Yudai Takada
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# breadkit-render
+
+Project site: https://breadkit.github.io/breadkit-render/
+
+`bkrender` turns a Breadkit DSL or resolved IR JSON file into a standalone SVG diagram. Breadkit DSL input is executable Ruby; only render files you trust. IR JSON is the data-only alternative.
+
+Install `breadkit-render` directly; RubyGems installs its compatible `breadkit` core dependency. Shared circuit examples are in the [breadkit repository](https://github.com/breadkit/breadkit/tree/main/examples).
+
+```sh
+bkrender circuit.bk.rb -o circuit.svg --show-nets --legend
+bkrender circuit.bk.rb -o circuit.png --scale 3 --theme light
+bkrender circuit.bk.rb -o circuit.svg --orientation landscape
+bkrender circuit.bk.rb -o circuit.svg --rail-pattern '+--+'
+bkrender circuit.bk.rb --format svg > circuit.svg
+```
+
+## Example output
+
+Generated from the shared [RP2040 sensor demo](https://github.com/breadkit/breadkit/blob/main/examples/05_sensor_demo.bk.rb). It uses the full-size 830-point board model. The image crops to the used area: the controller occupies rows 1–20, with switches and IR connections below and OLED/SHT31 modules beside it.
+
+Rendered with `bkrender ../breadkit/examples/05_sensor_demo.bk.rb -o docs/images/sensor-demo.png --crop auto --rail-pattern '+--+' --scale 2`:
+
+<img src="docs/images/sensor-demo.png" alt="RP2040 sensor demo on a full-size breadboard with OLED, two SHT31 modules, two switches, and IR receiver and emitter wiring" width="800">
+
+[Open the interactive SVG](docs/images/sensor-demo.svg). Its layer tabs isolate power, I2C, switches, IR, and the optional 5 V emitter wiring. The 5 V view is a dashed, visual-only alternative: remove the emitter's 3.3 V rail wire before applying it.
+
+The shared example defines the board and IR connectors in the breadkit repository's [`examples/parts`](https://github.com/breadkit/breadkit/tree/main/examples/parts). Pin `type:` values such as `power`, `ground`, `clock`, `data`, `address`, and `interrupt` color the markers. `offboard` modules use a neutral surface color; connected pin names are emphasized, unused pins are muted, and `address:` text is shown on the module. Assign `layer:` to wires and components to create matching interactive views. `route: :edge` routes long wires outside the board and separates wires that would otherwise overlap.
+
+Resistors use four color bands by default. Set `bands: 5` on a resistor for three significant digits and a 1% brown tolerance band.
+
+## Options
+
+| Option | Default | Description |
+| --- | --- | --- |
+| `-o, --output PATH` | stdout | Write to a file; `.svg`, `.png`, `.jpg`, and `.jpeg` select the format. |
+| `-f, --format FORMAT` | inferred or `svg` | `svg`, `png`, or `jpeg`. Conflicting extensions are errors. |
+| `--scale N` | `2` | Raster output scale. |
+| `--theme NAME` | `light` | `light`, `dark`, or `print`. |
+| `--orientation NAME` | `portrait` | `portrait` for a readable vertical board; `landscape` for a wide view. |
+| `--rail-pattern PATTERN` | board layout | Assign `+`/`-` to the four rails in portrait order: left outer, left inner, right inner, right outer. Accepted patterns: `+--+`, `+-+-`, `-+-+`, `-++-`. Rail connections move with their assigned polarity. |
+| `--color-by MODE` | `wire` | Use declared wire colors or deterministic net colors. |
+| `--show-nets` | off | Add net labels to the diagram. |
+| `--legend` | off | Add the title, connected net names, and representative wire colors. |
+| `--crop MODE` | `auto` | `auto` crops to circuit content; `none` shows the full board. |
+| `--annotations FILE` | none | Overlay offenses from `bklint --format json`. |
+| `--backend NAME` | `auto` | Raster backend: `rsvg`, `vips`, or `magick`. |
+| `--background COLOR` | white | JPEG background: basic CSS color name, `#RGB`, or `#RRGGBB`. PNG and SVG reject this option. |
+| `--quality N` | `90` | JPEG quality. |
+| `--static` | off | Omit SVG layer controls and embedded scripts. |
+| `--force` | off | Draw resolved elements even when the input has layout errors. |
+
+## Raster backends
+
+SVG is rendered without extra dependencies. PNG uses the first available backend in the order `rsvg-convert`, `ruby-vips`, ImageMagick. JPEG uses `ruby-vips` or ImageMagick and is flattened onto the configured background. Install `librsvg` (`brew install librsvg` or `apt install librsvg2-bin`) or ImageMagick for raster output. `ruby-vips` also needs a libvips build with SVG support.
+
+Connected breadboard holes and physically occupied holes use different markers. LED colors accept CSS color names and hexadecimal colors such as `#6d5af0`.
+
+The SVG uses a system font stack including Noto Sans JP. Rasterized Japanese labels need a Japanese font installed in the environment.

data/SECURITY.md

@@ -0,0 +1,5 @@
+# Security policy
+
+DSL files are executable Ruby. Do not process files from untrusted sources; use IR JSON for data-only input.
+
+Please report suspected vulnerabilities privately through GitHub's Security Advisories feature. Do not include exploit details in a public issue.