# circuiteria

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="A platypus / Perry the Platypus meme made with colored rounded rectangles">
</p>

## Examples
<table>
  <tr>
    <td colspan="2">
      <a href="./gallery/test.typ">
        <img src="./gallery/test.png" width="500px" alt="Block diagram of a multi-cycle RISC-V FPGA processor">
      </a>
    </td>
  </tr>
  <tr>
    <td colspan="2">A bit of everything</td>
  </tr>
  <tr>
    <td colspan="2">
      <a href="./gallery/test5.typ">
        <img src="./gallery/test5.png" width="500px" alt="Block diagram of a single-cycle RISC-V processor">
      </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" alt="Top-level block diagram of a single-cycle RISC-V processor">
      </a>
    </td>
    <td>
      <a href="./gallery/test6.typ">
        <img src="./gallery/test6.png" width="250px" alt="Block diagram of a simple single-cycle RISC-V ALU">
      </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 more information, see the [manual](manual.pdf)

To use this package, simply import [circuiteria](https://typst.app/universe/package/circuiteria) and call the `circuit` function:
```typ
#import "@preview/circuiteria:0.2.1"
#circuiteria.circuit({
  import circuiteria: *
  ...
})
```