diff --git a/README.md b/README.md index bd7dbb0..6ef5327 100644 --- a/README.md +++ b/README.md @@ -31,14 +31,11 @@ It is based on the [homonymous Python script](https://git.kb28.ch/HEL/rivet/) *Click on the example image to jump to the code.* ## Usage -For information, see the [manual](manual.pdf) +For more information, see the [manual](manual.pdf) -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à ! +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à ! ```typ -#import "src/lib.typ": schema +#import "@preview/rivet:0.1.0": schema #let doc = schema.load("path/to/schema.yaml") #schema.render(doc) -``` - -## Installing -> TODO +``` \ No newline at end of file diff --git a/manual.pdf b/manual.pdf index 2031103..2f9a98e 100644 Binary files a/manual.pdf and b/manual.pdf differ diff --git a/manual.typ b/manual.typ index 214fdfe..566dd28 100644 --- a/manual.typ +++ b/manual.typ @@ -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à ! #pad(left: 1em)[```typ -#import "src/lib.typ": schema +#import "@preview/rivet:0.1.0": schema #let doc = schema.load("path/to/schema.yaml") #schema.render(doc) ```] diff --git a/src/lib.typ b/src/lib.typ index 8b19e84..4576f8b 100644 --- a/src/lib.typ +++ b/src/lib.typ @@ -1,4 +1,4 @@ -#let version = version((0,0,2)) +#let version = version(0,1,0) #import "config.typ" #import "schema.typ" \ No newline at end of file diff --git a/typst.toml b/typst.toml index 0145bae..3ef37c0 100644 --- a/typst.toml +++ b/typst.toml @@ -1,6 +1,6 @@ [package] name = "rivet" -version = "0.0.2" +version = "0.1.0" compiler = "0.11.0" repository = "https://git.kb28.ch/HEL/rivet-typst" entrypoint = "src/lib.typ" @@ -11,4 +11,4 @@ categories = [ "visualization" ] license = "Apache-2.0" description = "Register / Instruction Visualizer & Explainer Tool with Typst, using CeTZ" keywords = [ "assembly", "instruction", "binary" ] -exclude = [ "/gallery/*" ] \ No newline at end of file +exclude = [ "gallery", "gallery.bash", "docs" ] \ No newline at end of file