Register / Instruction Visualizer & Explainer Tool with Typst, using CeTZ
Go to file
2024-10-30 16:19:01 +01: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 fixed missing bit i on dependencies 2024-10-30 16:18:32 +01:00
CHANGELOG.md updated CHANGELOG.md 2024-10-02 18:58:11 +02:00
gallery.bash modified gallery.bash to compile recursively 2024-10-30 16:19:01 +01:00
LICENSE Initial commit 2024-05-19 10:17:37 +00:00
manual.pdf bumped to 0.1.0 for publication 2024-10-02 18:54:42 +02:00
manual.typ bumped to 0.1.0 for publication 2024-10-02 18:54:42 +02:00
README.md bumped to 0.1.0 for publication 2024-10-02 18:54:42 +02:00
typst.toml bumped to 0.1.0 for publication 2024-10-02 18:54:42 +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 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.1.0": schema
#let doc = schema.load("path/to/schema.yaml")
#schema.render(doc)