rivet-typst

RIVET (Register / Instruction Visualizer & Explainer Tool) is a Typst package for visualizing binary instructions or describing the contents of a register, using the CeTZ package.

It is based on the homonymous Python script

Examples

A black on white diagram showing the bit structure of a machine instruction, detailing operands, flags and selectors.

A bit of eveything

A white on blue diagram showing the bit structure of RISC-V memory instructions, detailing operands, flags and selectors.

RISC-V memory instructions (blueprint)

Click on the example image to jump to the code.

Usage

For more information, see the manual

To use this package, simply import schema from rivet and call schema.load to parse a schema description. Then use schema.render to render it, et voilà !

#import "@preview/rivet:0.3.1": schema
#let doc = schema.load(yaml("path/to/schema.yaml"))
#schema.render(doc)

rivet

Package Information

1. Get the package

2. Import in your Typst file

Version History

rivet-typst

Examples

Usage