Skip to content

Commit

Permalink
[update] gallery, readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Mc-Zen committed Jun 28, 2023
1 parent b8abd8c commit 772ec4b
Show file tree
Hide file tree
Showing 3 changed files with 874 additions and 824 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<h1 align="center">
<img alt="Quantum Circuit" src="docs/images/logo.svg" style="max-width: 100%; width: 300pt; padding: 10px 20px; box-shadow: 1pt 1pt 10pt 0pt #AAAAAA; border-radius: 4pt">
<img alt="Quantum Circuit" src="docs/images/logo.svg" style="max-width: 100%; width: 300pt; padding: 10px 20px; box-shadow: 1pt 1pt 10pt 0pt #AAAAAA; border-radius: 4pt;box-sizing: border-box;">
</h1>


Expand All @@ -12,9 +12,9 @@
**Quill** is a package for creating quantum circuit diagrams in [Typst](https://typst.app/).


Note, that this package is in beta and may still be undergoing breaking changes. As new features like data types and scoped functions will be added to Typst, this package will be adapted to profit from the new paradigms.
_Note, that this package is in beta and may still be undergoing breaking changes. As new features like data types and scoped functions will be added to Typst, this package will be adapted to profit from the new paradigms._

Meanwhile, we suggest importing everything from `quill.typ` in a local scope to avoid polluting the global namespace (see example below).
_Meanwhile, we suggest importing everything from `quill.typ` in a local scope to avoid polluting the global namespace (see example below)._

<!-- ## Setup
Expand All @@ -33,9 +33,9 @@ Create circuit diagrams by calling the function `quantum-circuit()` with any num
)
}
```
<p align="center">
<h3 align="center">
<img alt="Quantum Circuit" src="docs/images/bell.svg" style="max-width: 100%; padding: 10px 10px; box-shadow: 1pt 1pt 10pt 0pt #AAAAAA; border-radius: 4pt">
</p>
</h3>

Refer to the [user guide](https://github.com/Mc-Zen/quill/blob/main/docs/guide/quill-guide.pdf) for full documentation.

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/gallery.typ
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
[Controlled \  #smallcaps("z")-gate], quantum-circuit(1, ctrl(1), 1, [\ ], 1, ctrl(0), 1), [#raw("ctrl(1)") \ + \ #raw("ctrl(0)")],
[Controlled \  #smallcaps("x")-gate], quantum-circuit(1, ctrl(1), 1, [\ ], 1, targ(), 1), [#raw("ctrl(1)") \ + \ #raw("targ()")],
[Swap \  gate], quantum-circuit(1, swap(1), 1, [\ ], 1, targX(), 1), [#raw("swap(1)") \ + \ #raw("targX()")],
[Controlled \ Hadamard], quantum-circuit(1, mqgate($H$, target: 1), 1, [\ ], 1, ctrl(0), 1), [#raw("mqgate($H$,target:1)") \ + \ #raw("ctrl(0)")],
[Controlled \ Hadamard], quantum-circuit(1, mqgate($H$, target: 1), 1, [\ ], 1, ctrl(0), 1), [#raw("mqgate($H$,\ntarget:1)") \ + \ #raw("ctrl(0)")],
[Plain\ vertical\ wire], quantum-circuit(1, ctrl(1, show-dot: false), 1, [\ ], 3), raw("ctrl(1, show-dot: false)"),
[Meter to \ classical], quantum-circuit(1, meter(target: 1), 1, [\ ], setwire(2), 1, ctrl(0), 1), [#raw("meter(target: 1)") \ + \ #raw("ctrl(0)")],
)
Expand Down
Loading

0 comments on commit 772ec4b

Please sign in to comment.