Compare commits
	
		
			2 Commits
		
	
	
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 6f502f2e18 | |||
| 03e9904d43 | 
| @@ -1,5 +1,8 @@ | ||||
| # Changelog | ||||
|  | ||||
| ## [v0.1.0] - 2024-10-02 | ||||
| - prepared for publication in Typst Universe | ||||
|  | ||||
| ## [v0.0.2] - 2024-06-15 | ||||
| ### Added | ||||
| - `width` parameter to `schema.render` for easier integration | ||||
|   | ||||
| @@ -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 | ||||
|   | ||||
							
								
								
									
										
											BIN
										
									
								
								manual.pdf
									
									
									
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								manual.pdf
									
									
									
									
									
								
							
										
											Binary file not shown.
										
									
								
							| @@ -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) | ||||
| ```] | ||||
|   | ||||
| @@ -1,4 +1,4 @@ | ||||
| #let version = version((0,0,2)) | ||||
| #let version = version(0,1,0) | ||||
|  | ||||
| #import "config.typ" | ||||
| #import "schema.typ" | ||||
| @@ -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/*" ] | ||||
| exclude = [ "gallery", "gallery.bash", "docs" ] | ||||
		Reference in New Issue
	
	Block a user