aboutsummaryrefslogtreecommitdiff
path: root/examples/README.md
diff options
context:
space:
mode:
authorhachem <im@hachem.wtf>2024-09-29 11:03:24 +0200
committerhachem <im@hachem.wtf>2024-09-29 11:03:24 +0200
commit127cee88ad2ade892dbcebc218ff006d008a8371 (patch)
treeb350bee5d041262e6c7214fbef2173f8ffbbc95f /examples/README.md
parent2770097e25e7fb5090efe0f85340f0c638f9dd71 (diff)
start work on basic examples
Diffstat (limited to 'examples/README.md')
-rw-r--r--examples/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 0000000..47cbfd5
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,12 @@
+# Examples
+In this directory, you will find a series of directories providing examples on how to use all the $\psi$ libraries. Since this entire project is based on workspaces, all you have to do use the following command:
+```sh
+$ cargo run -p [example name]
+```
+
+For instance:
+```sh
+$ cargo run -p simple_gates
+$ cargo run -p visualizers
+...
+``` \ No newline at end of file