Compare commits
	
		
			3 Commits
		
	
	
		
			d8094384ad
			...
			v0.1.0
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 9a1fda087c | |||
| c5a0cf7ecc | |||
| 9a6973fb89 | 
							
								
								
									
										33
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										33
									
								
								README.md
									
									
									
									
									
								
							| @@ -3,15 +3,15 @@ | ||||
| Circuiteria is a [Typst](https://typst.app) package for drawing block circuit diagrams using the [CeTZ](https://typst.app/universe/package/cetz) package. | ||||
|  | ||||
| <p align="center"> | ||||
|   <img src="gallery/platypus.png" alt="Perry the platypus"> | ||||
|   <img src="./gallery/platypus.png" alt="Perry the platypus"> | ||||
| </p> | ||||
|  | ||||
| ## Examples | ||||
| <table> | ||||
|   <tr> | ||||
|     <td colspan="2"> | ||||
|       <a href="gallery/test.typ"> | ||||
|         <img src="gallery/test.png" width="500px"> | ||||
|       <a href="./gallery/test.typ"> | ||||
|         <img src="./gallery/test.png" width="500px"> | ||||
|       </a> | ||||
|     </td> | ||||
|   </tr> | ||||
| @@ -20,8 +20,8 @@ Circuiteria is a [Typst](https://typst.app) package for drawing block circuit di | ||||
|   </tr> | ||||
|   <tr> | ||||
|     <td colspan="2"> | ||||
|       <a href="gallery/test5.typ"> | ||||
|         <img src="gallery/test5.png" width="500px"> | ||||
|       <a href="./gallery/test5.typ"> | ||||
|         <img src="./gallery/test5.png" width="500px"> | ||||
|       </a> | ||||
|     </td> | ||||
|   </tr> | ||||
| @@ -30,13 +30,13 @@ Circuiteria is a [Typst](https://typst.app) package for drawing block circuit di | ||||
|   </tr> | ||||
|   <tr> | ||||
|     <td> | ||||
|       <a href="gallery/test4.typ"> | ||||
|         <img src="gallery/test4.png" width="250px"> | ||||
|       <a href="./gallery/test4.typ"> | ||||
|         <img src="./gallery/test4.png" width="250px"> | ||||
|       </a> | ||||
|     </td> | ||||
|     <td> | ||||
|       <a href="gallery/test6.typ"> | ||||
|         <img src="gallery/test6.png" width="250px"> | ||||
|       <a href="./gallery/test6.typ"> | ||||
|         <img src="./gallery/test6.png" width="250px"> | ||||
|       </a> | ||||
|     </td> | ||||
|   </tr> | ||||
| @@ -52,16 +52,13 @@ Circuiteria is a [Typst](https://typst.app) package for drawing block circuit di | ||||
| *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 [src/lib.typ](src/lib.typ) and call the `circuit` function: | ||||
| To use this package, simply import [circuiteria](https://typst.app/universe/package/circuiteria) and call the `circuit` function: | ||||
| ```typ | ||||
| #import "src/lib.typ" | ||||
| #lib.circuit({ | ||||
|   import lib: * | ||||
| #import "@preview/circuiteria:0.1.0" | ||||
| #circuiteria.circuit({ | ||||
|   import circuiteria: * | ||||
|   ... | ||||
| }) | ||||
| ``` | ||||
|  | ||||
| ## Installing | ||||
| > TODO | ||||
| ``` | ||||
							
								
								
									
										
											BIN
										
									
								
								manual.pdf
									
									
									
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								manual.pdf
									
									
									
									
									
								
							
										
											Binary file not shown.
										
									
								
							| @@ -52,13 +52,13 @@ | ||||
|   h: none, | ||||
|   name: none, | ||||
|   name-anchor: "center", | ||||
|   ports: (), | ||||
|   ports-margins: (), | ||||
|   ports: (:), | ||||
|   ports-margins: (:), | ||||
|   fill: none, | ||||
|   stroke: black + 1pt, | ||||
|   id: "", | ||||
|   auto-ports: true, | ||||
|   ports-y: (), | ||||
|   ports-y: (:), | ||||
|   debug: ( | ||||
|     ports: false | ||||
|   ) | ||||
|   | ||||
| @@ -1,4 +1,4 @@ | ||||
| #let version = version((0,0,3)) | ||||
| #let version = version(0, 1, 0) | ||||
|  | ||||
| #import "circuit.typ": circuit | ||||
| #import "element.typ" | ||||
|   | ||||
| @@ -1,6 +1,6 @@ | ||||
| [package] | ||||
| name = "circuiteria" | ||||
| version = "0.0.3" | ||||
| version = "0.1.0" | ||||
| compiler = "0.11.0" | ||||
| repository = "https://git.kb28.ch/HEL/circuiteria" | ||||
| entrypoint = "src/lib.typ" | ||||
| @@ -11,4 +11,4 @@ categories = [ "visualization" ] | ||||
| license = "Apache-2.0" | ||||
| description = "Drawing block circuits with Typst made easy, using CeTZ" | ||||
| keywords = [ "circuit", "block", "draw" ] | ||||
| exclude = [ "/gallery/*" ] | ||||
| exclude = [ "gallery", "gallery.bash", "doc" ] | ||||
		Reference in New Issue
	
	Block a user