aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhachem <im@hachem.wtf>2024-09-15 14:07:19 +0200
committerhachem <im@hachem.wtf>2024-09-15 14:07:19 +0200
commitaca7dbace9f02a85004ad9b61a410977cd6c64f1 (patch)
tree56a84620cb55afaed9685d2643f3e3c97435d2cb
parent6afec96567c1735b539214d87fb9069ad0828904 (diff)
Update README
-rw-r--r--README.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9791710..346a43b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,10 @@
-# mu
-A Quantum Mechanics Toolkit
+# μ
+μ, pronounced $\text{/mj'uː/ ('mew')}$ and not $\text{/mŷː/ ('mee')}$, is powerful quantum computational toolkit based on the idea of simulation of quantum circuits on classical computers.
+
+## Project Prospects
+- `libmu`: A dependency free library featuring an enviroment to write and design quantum circuits, used by all sub-projects in μ. Fitted with a series of bindings to allow use in different languages.
+- `muc`: Pronounced $\text{/mjˈuː sˈiː/ ('mew'-'see')}$, an [OpenQASM](https://openqasm.com/) compiler allowing you to write quantum programs and have them be complied to native executables ran on classical computers using an [LLVM](https://llvm.org/) backend.
+- `mu`: An application allowing you to design quantum circuits graphically instead of programatically. Using both `libmu` and `muc`, you are capable of designing your own quantum gates by the use of an [OpenQASM]([https://openqasm.com/](https://openqasm.com/)) gate descriptor.
+
+## Disclaimer
+This project is a large and ongoing effort, and I try my hardest to deliver the advertised feature, some may not arrive as planned or according to any scheduled timeline. The development process is subject to change based on technical challenges, research priorities and the simultaneous management of multiple on-going projects, spanning both computer science, physics and unrelated domains.