Compare commits
No commits in common. "d8094384ad167f1927b80c113e2afcc37e93ed36" and "64d6635d5f726fdecf5f7f934bdb0951dfbf2369" have entirely different histories.
d8094384ad
...
64d6635d5f
66
README.md
66
README.md
@ -1,67 +1,3 @@
|
|||||||
# circuiteria
|
# circuiteria
|
||||||
|
|
||||||
Circuiteria is a [Typst](https://typst.app) package for drawing block circuit diagrams using the [CeTZ](https://typst.app/universe/package/cetz) package.
|
Drawing block circuits with Typst made easy, using CeTZ
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
<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>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td colspan="2">A bit of eveything</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td colspan="2">
|
|
||||||
<a href="gallery/test5.typ">
|
|
||||||
<img src="gallery/test5.png" width="500px">
|
|
||||||
</a>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td colspan="2">Wires everywhere</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>
|
|
||||||
<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>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>Groups</td>
|
|
||||||
<td>Rotated</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
> **Note**\
|
|
||||||
> These circuit layouts were copied from a digital design course given by prof. S. Zahno and recreated using this package
|
|
||||||
|
|
||||||
*Click on the example image to jump to the code.*
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
For information, see the [manual](manual.pdf)
|
|
||||||
|
|
||||||
To use this package, simply import [src/lib.typ](src/lib.typ) and call the `circuit` function:
|
|
||||||
```typ
|
|
||||||
#import "src/lib.typ"
|
|
||||||
#lib.circuit({
|
|
||||||
import lib: *
|
|
||||||
...
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
## Installing
|
|
||||||
> TODO
|
|
Binary file not shown.
Binary file not shown.
Before Width: | Height: | Size: 45 KiB |
@ -1,77 +0,0 @@
|
|||||||
#import "../src/lib.typ": *
|
|
||||||
|
|
||||||
#set page(width: auto, height: auto, margin: .5cm)
|
|
||||||
|
|
||||||
#let teal = rgb(37, 155, 166)
|
|
||||||
#let orange = rgb(254, 160, 93)
|
|
||||||
#let brown = rgb(97, 54, 60)
|
|
||||||
|
|
||||||
#circuit({
|
|
||||||
element.group(id: "platypus", name: "A platypus", {
|
|
||||||
element.block(
|
|
||||||
x: 0, y: 0, w: 2, h: 3, id: "body",
|
|
||||||
fill: teal,
|
|
||||||
ports: (
|
|
||||||
east: (
|
|
||||||
(id: "out"),
|
|
||||||
)
|
|
||||||
),
|
|
||||||
ports-margins: (
|
|
||||||
east: (50%, 10%)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
element.block(
|
|
||||||
x: 2.5, y: 1.5, w: 1.5, h: 1, id: "beak",
|
|
||||||
fill: orange,
|
|
||||||
ports: (
|
|
||||||
south: (
|
|
||||||
(id: "in"),
|
|
||||||
)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
wire.wire("w1", ("body-port-out", "beak-port-in"), style: "zigzag", zigzag-ratio: 100%)
|
|
||||||
})
|
|
||||||
|
|
||||||
let O = (rel: (2, 0), to: "platypus.south-east")
|
|
||||||
|
|
||||||
element.group(id: "perry", name: "Perry the platypus", {
|
|
||||||
element.block(
|
|
||||||
x: (rel: 0, to: O), y: 0, w: 2, h: 3, id: "body",
|
|
||||||
fill: teal,
|
|
||||||
ports: (
|
|
||||||
east: (
|
|
||||||
(id: "out"),
|
|
||||||
)
|
|
||||||
),
|
|
||||||
ports-margins: (
|
|
||||||
east: (50%, 10%)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
element.block(
|
|
||||||
x: (rel: 2.5, to: O), y: 1.5, w: 1.5, h: 1, id: "beak",
|
|
||||||
fill: orange,
|
|
||||||
ports: (
|
|
||||||
south: (
|
|
||||||
(id: "in"),
|
|
||||||
)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
element.block(
|
|
||||||
x: (rel: 0.25, to: O), y: 3.2, w: 1.5, h: 0.5, id: "hat",
|
|
||||||
fill: brown
|
|
||||||
)
|
|
||||||
|
|
||||||
wire.wire("w2", ("body-port-out", "beak-port-in"), style: "zigzag", zigzag-ratio: 100%)
|
|
||||||
})
|
|
||||||
|
|
||||||
wire.wire(
|
|
||||||
"w3",
|
|
||||||
("platypus.east", (horizontal: "perry.west", vertical: ())),
|
|
||||||
directed: true,
|
|
||||||
bus: true
|
|
||||||
)
|
|
||||||
})
|
|
Binary file not shown.
@ -18,7 +18,7 @@
|
|||||||
name: "Datapath",
|
name: "Datapath",
|
||||||
ports: (
|
ports: (
|
||||||
north: (
|
north: (
|
||||||
(id: "clk", clock: true, small: true),
|
(id: "clk", clock: true),
|
||||||
(id: "Zero"),
|
(id: "Zero"),
|
||||||
(id: "Regsrc"),
|
(id: "Regsrc"),
|
||||||
(id: "PCSrc"),
|
(id: "PCSrc"),
|
||||||
@ -104,7 +104,7 @@
|
|||||||
name: "Data\n Memory",
|
name: "Data\n Memory",
|
||||||
ports: (
|
ports: (
|
||||||
north: (
|
north: (
|
||||||
(id: "clk", clock: true, small: true),
|
(id: "clk", clock: true),
|
||||||
(id: "WE", name: "WE")
|
(id: "WE", name: "WE")
|
||||||
),
|
),
|
||||||
west: (
|
west: (
|
||||||
|
Loading…
Reference in New Issue
Block a user