HEL/rivet-typst
1
0
Fork 0
Code Issues 2 Pull Requests Releases 2 Activity

Compare commits

base: HEL:main
Branches Tags
HEL:main
HEL:dev
HEL:v0.1.0
HEL:v0.0.2
HEL:v0.0.1
..
compare: HEL:v0.0.2
Branches Tags
HEL:dev
HEL:main
HEL:v0.1.0
HEL:v0.0.2
HEL:v0.0.1

No commits in common. "main" and "v0.0.2" have entirely different histories.
main ... v0.0.2

6 changed files with 11 additions and 11 deletions
Show Stats Expand all files Collapse all files

3
CHANGELOG.md
View File

@ -1,8 +1,5 @@
# Changelog # Changelog
## [v0.1.0] - 2024-10-02
- prepared for publication in Typst Universe
## [v0.0.2] - 2024-06-15 ## [v0.0.2] - 2024-06-15
### Added ### Added
- `width` parameter to `schema.render` for easier integration - `width` parameter to `schema.render` for easier integration

9
README.md
View File

@ -31,11 +31,14 @@ It is based on the [homonymous Python script](https://git.kb28.ch/HEL/rivet/)
*Click on the example image to jump to the code.* *Click on the example image to jump to the code.*
## Usage ## Usage
For more information, see the [manual](manual.pdf) For information, see the [manual](manual.pdf)
To use this package, simply import `schema` from [rivet](https://typst.app/universe/package/rivet) and call `schema.load` to parse a schema description. Then use `schema.render` to render it, et voilà ! To use this package, simply import `schema` [src/lib.typ](src/lib.typ) and call `schema.load` to parse a schema description. Then use `schema.render` to render it, et voilà !
```typ ```typ
#import "@preview/rivet:0.1.0": schema #import "src/lib.typ": schema
#let doc = schema.load("path/to/schema.yaml") #let doc = schema.load("path/to/schema.yaml")
#schema.render(doc) #schema.render(doc)
``` ```
## Installing
> TODO

BIN
manual.pdf
View File

Binary file not shown.

2
manual.typ
View File

@ -53,7 +53,7 @@ This is a port of the #link("https://git.kb28.ch/HEL/rivet")[homonymous Python s
Simply import `schema` from #link("src/lib.typ") and call `schema.load` to parse a schema description. Then use `schema.render` to render it, et voilà ! Simply import `schema` from #link("src/lib.typ") and call `schema.load` to parse a schema description. Then use `schema.render` to render it, et voilà !
#pad(left: 1em)[```typ #pad(left: 1em)[```typ
#import "@preview/rivet:0.1.0": schema #import "src/lib.typ": schema
#let doc = schema.load("path/to/schema.yaml") #let doc = schema.load("path/to/schema.yaml")
#schema.render(doc) #schema.render(doc)
```] ```]

2
src/lib.typ
View File

@ -1,4 +1,4 @@
#let version = version(0,1,0) #let version = version((0,0,2))
#import "config.typ" #import "config.typ"
#import "schema.typ" #import "schema.typ"

4
typst.toml
View File

@ -1,6 +1,6 @@
[package] [package]
name = "rivet" name = "rivet"
version = "0.1.0" version = "0.0.2"
compiler = "0.11.0" compiler = "0.11.0"
repository = "https://git.kb28.ch/HEL/rivet-typst" repository = "https://git.kb28.ch/HEL/rivet-typst"
entrypoint = "src/lib.typ" entrypoint = "src/lib.typ"
@ -11,4 +11,4 @@ categories = [ "visualization" ]
license = "Apache-2.0" license = "Apache-2.0"
description = "Register / Instruction Visualizer & Explainer Tool with Typst, using CeTZ" description = "Register / Instruction Visualizer & Explainer Tool with Typst, using CeTZ"
keywords = [ "assembly", "instruction", "binary" ] keywords = [ "assembly", "instruction", "binary" ]
exclude = [ "gallery", "gallery.bash", "docs" ] exclude = [ "/gallery/*" ]