Register / Instruction Visualizer & Explainer Tool with Typst, using CeTZ
Go to file
2024-06-15 14:14:07 +02:00
docs added support for colored ranges 2024-06-14 11:20:32 +02:00
gallery added color support for json, yaml and xml 2024-06-15 13:17:27 +02:00
src added color support for json, yaml and xml 2024-06-15 13:17:27 +02:00
CHANGELOG.md updated CHANGELOG.md 2024-06-15 14:14:07 +02:00
gallery.bash updated gallery 2024-06-14 11:20:43 +02:00
LICENSE Initial commit 2024-05-19 10:17:37 +00:00
manual.pdf added format specification in the manual 2024-06-15 14:13:07 +02:00
manual.typ added format specification in the manual 2024-06-15 14:13:07 +02:00
README.md resized README images 2024-05-19 18:08:52 +02:00
typst.toml updated package version to 0.0.2 2024-06-13 12:49:18 +02:00

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