Skip to content

README: headless export example image and command - #51

Merged
xtofalex merged 1 commit into
mainfrom
readme-headless-example
Nov 16, 2026
Merged

xtofalex merged 1 commit into
mainfrom
readme-headless-example

Conversation

@xtofalex

Copy link
Copy Markdown
Contributor

Adds a headless export example to both READMEs:

  • docs/headless_export.png: the fan-in cones of two divider flip-flops (div.count[0], div.req_tag[0]) of the tinyrocket core in scripts/, overlaid, with title and legend, drawn at 2x.
  • Top README (Headless SVG export): the naja-schematic-standalone --png command that produced it, and a note that exports serve people (docs, reviews, bug reports) and tools (scripts, CI, AI agents attaching a picture to their findings).
  • Python README (SVG and PNG export): the equivalent naja-schematic render command (checked: same drawing, only the legend's trace label differs, .D vs /D), image by absolute raw.githubusercontent URL so PyPI renders it.
  • REUSE.toml: the new image (reuse lint passes).

Note: the image uses scripts/NangateOpenCellLibrary_typical.lib; the tutorial tutorial_cells.lib in my local naja checkout has no cell functions or timing, so cells draw as boxes and traces stop after one cell.

Add docs/headless_export.png, the fan-in cones of two divider flops of
the tinyrocket core in scripts/, with the command that draws it: the
desktop app's --png in the top README, naja-schematic render in the
Python package README (absolute image URL, so PyPI shows it). Explain
that exports serve people (docs, reviews, bug reports) and tools (CI,
scripts, AI agents attaching a picture to their findings).
@xtofalex
xtofalex merged commit c2e7003 into main Nov 16, 2026
25 checks passed
@xtofalex
xtofalex deleted the readme-headless-example branch November 16, 2026 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant