Create README.md

danielmpla · May 28, 2021 · a7affae · a7affae
1 parent 77d0978
commit a7affae
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,10 @@
+# rsaQuantaCrack
+Demonstrator for Shor factorization of 15
+
+This program was create for the lecture QC for MINT (STEM) at TU Dresden. The quantum code itself was copied from https://qiskit.org/textbook/ch-algorithms/shor.html
+
+However, a user experience for demonstration purposes was added as you can see in the following picture.
+
+![](./screenshot.jpg)
+
+This application can be converted to an *.exe file using auto-py-to-exe (included in the requirements). When using this compiler, please make sure to add under `Advanced > Other` `--collect-submodules sklearn` and `--collect-data qiskit`.