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. | 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"> | <p align="center"> | ||||||
|   <img src="gallery/platypus.png" alt="Perry the platypus"> |   <img src="./gallery/platypus.png" alt="Perry the platypus"> | ||||||
| </p> | </p> | ||||||
|  |  | ||||||
| ## Examples | ## Examples | ||||||
| <table> | <table> | ||||||
|   <tr> |   <tr> | ||||||
|     <td colspan="2"> |     <td colspan="2"> | ||||||
|       <a href="gallery/test.typ"> |       <a href="./gallery/test.typ"> | ||||||
|         <img src="gallery/test.png" width="500px"> |         <img src="./gallery/test.png" width="500px"> | ||||||
|       </a> |       </a> | ||||||
|     </td> |     </td> | ||||||
|   </tr> |   </tr> | ||||||
| @@ -20,8 +20,8 @@ Circuiteria is a [Typst](https://typst.app) package for drawing block circuit di | |||||||
|   </tr> |   </tr> | ||||||
|   <tr> |   <tr> | ||||||
|     <td colspan="2"> |     <td colspan="2"> | ||||||
|       <a href="gallery/test5.typ"> |       <a href="./gallery/test5.typ"> | ||||||
|         <img src="gallery/test5.png" width="500px"> |         <img src="./gallery/test5.png" width="500px"> | ||||||
|       </a> |       </a> | ||||||
|     </td> |     </td> | ||||||
|   </tr> |   </tr> | ||||||
| @@ -30,13 +30,13 @@ Circuiteria is a [Typst](https://typst.app) package for drawing block circuit di | |||||||
|   </tr> |   </tr> | ||||||
|   <tr> |   <tr> | ||||||
|     <td> |     <td> | ||||||
|       <a href="gallery/test4.typ"> |       <a href="./gallery/test4.typ"> | ||||||
|         <img src="gallery/test4.png" width="250px"> |         <img src="./gallery/test4.png" width="250px"> | ||||||
|       </a> |       </a> | ||||||
|     </td> |     </td> | ||||||
|     <td> |     <td> | ||||||
|       <a href="gallery/test6.typ"> |       <a href="./gallery/test6.typ"> | ||||||
|         <img src="gallery/test6.png" width="250px"> |         <img src="./gallery/test6.png" width="250px"> | ||||||
|       </a> |       </a> | ||||||
|     </td> |     </td> | ||||||
|   </tr> |   </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.* | *Click on the example image to jump to the code.* | ||||||
|  |  | ||||||
| ## Usage | ## 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 | ```typ | ||||||
| #import "src/lib.typ" | #import "@preview/circuiteria:0.1.0" | ||||||
| #lib.circuit({ | #circuiteria.circuit({ | ||||||
|   import lib: * |   import circuiteria: * | ||||||
|   ... |   ... | ||||||
| }) | }) | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## Installing |  | ||||||
| > TODO |  | ||||||
							
								
								
									
										
											BIN
										
									
								
								manual.pdf
									
									
									
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								manual.pdf
									
									
									
									
									
								
							
										
											Binary file not shown.
										
									
								
							| @@ -52,13 +52,13 @@ | |||||||
|   h: none, |   h: none, | ||||||
|   name: none, |   name: none, | ||||||
|   name-anchor: "center", |   name-anchor: "center", | ||||||
|   ports: (), |   ports: (:), | ||||||
|   ports-margins: (), |   ports-margins: (:), | ||||||
|   fill: none, |   fill: none, | ||||||
|   stroke: black + 1pt, |   stroke: black + 1pt, | ||||||
|   id: "", |   id: "", | ||||||
|   auto-ports: true, |   auto-ports: true, | ||||||
|   ports-y: (), |   ports-y: (:), | ||||||
|   debug: ( |   debug: ( | ||||||
|     ports: false |     ports: false | ||||||
|   ) |   ) | ||||||
|   | |||||||
| @@ -1,4 +1,4 @@ | |||||||
| #let version = version((0,0,3)) | #let version = version(0, 1, 0) | ||||||
|  |  | ||||||
| #import "circuit.typ": circuit | #import "circuit.typ": circuit | ||||||
| #import "element.typ" | #import "element.typ" | ||||||
|   | |||||||
| @@ -1,6 +1,6 @@ | |||||||
| [package] | [package] | ||||||
| name = "circuiteria" | name = "circuiteria" | ||||||
| version = "0.0.3" | version = "0.1.0" | ||||||
| compiler = "0.11.0" | compiler = "0.11.0" | ||||||
| repository = "https://git.kb28.ch/HEL/circuiteria" | repository = "https://git.kb28.ch/HEL/circuiteria" | ||||||
| entrypoint = "src/lib.typ" | entrypoint = "src/lib.typ" | ||||||
| @@ -11,4 +11,4 @@ categories = [ "visualization" ] | |||||||
| license = "Apache-2.0" | license = "Apache-2.0" | ||||||
| description = "Drawing block circuits with Typst made easy, using CeTZ" | description = "Drawing block circuits with Typst made easy, using CeTZ" | ||||||
| keywords = [ "circuit", "block", "draw" ] | keywords = [ "circuit", "block", "draw" ] | ||||||
| exclude = [ "/gallery/*" ] | exclude = [ "gallery", "gallery.bash", "doc" ] | ||||||
		Reference in New Issue
	
	Block a user