diff --git a/README.md b/README.md index 4a3f2b5..b9008d0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,67 @@ # circuiteria -Drawing block circuits with Typst made easy, using CeTZ \ No newline at end of file +Circuiteria is a [Typst](https://typst.app) package for drawing block circuit diagrams using the [CeTZ](https://typst.app/universe/package/cetz) package. + +

+ Perry the platypus +

+ +## Examples + + + + + + + + + + + + + + + + + + + + + +
+ + + +
A bit of eveything
+ + + +
Wires everywhere
+ + + + + + + +
GroupsRotated
+ +> **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 diff --git a/gallery/platypus.pdf b/gallery/platypus.pdf index dd448bb..e288eb0 100644 Binary files a/gallery/platypus.pdf and b/gallery/platypus.pdf differ diff --git a/gallery/platypus.png b/gallery/platypus.png index 517e345..9338a23 100644 Binary files a/gallery/platypus.png and b/gallery/platypus.png differ diff --git a/gallery/platypus.typ b/gallery/platypus.typ index 08649fa..4cc190d 100644 --- a/gallery/platypus.typ +++ b/gallery/platypus.typ @@ -1,6 +1,6 @@ #import "../src/lib.typ": * -//#set page(width: auto, height: auto, margin: .5cm) +#set page(width: auto, height: auto, margin: .5cm) #let teal = rgb(37, 155, 166) #let orange = rgb(254, 160, 93)