rivet-typst/README.md

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 bit of eveything

RISC-V memory instructions (blueprint)

Click on the example image to jump to the code.

Usage

For information, see the manual

To use this package, simply import schema src/lib.typ and call schema.load to parse a schema description. Then use schema.render to render it, et voilà !

#import "src/lib.typ": schema
#let doc = schema.load("path/to/schema.yaml")
#schema.render(doc)

Installing

TODO