Skip to content

Commit d863877

Browse files
website link and latex formatting fix
1 parent 235ddef commit d863877

2 files changed

Lines changed: 15 additions & 3 deletions

File tree

.github/workflows/pages.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -523,6 +523,16 @@ jobs:
523523
<meta name="theme-color" content="#0f5364">
524524
<title>{title}</title>
525525
<link rel="stylesheet" href="styles.css">
526+
<script>
527+
window.MathJax = {{
528+
tex: {{
529+
inlineMath: [["$", "$"], ["\\\\(", "\\\\)"]],
530+
displayMath: [["$$", "$$"], ["\\\\[", "\\\\]"]],
531+
processEscapes: true
532+
}}
533+
}};
534+
</script>
535+
<script defer src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js"></script>
526536
</head>
527537
<body>
528538
<a class="skip-link" href="#top">Skip to main content</a>

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
[![Tests](https://github.com/SidRichardsQuantum/Shors_Algorithm_Simulation/actions/workflows/tests.yml/badge.svg)](https://github.com/SidRichardsQuantum/Shors_Algorithm_Simulation/actions/workflows/tests.yml)
44

5+
**Project website:** [https://SidRichardsQuantum.github.io/Shors_Algorithm_Simulation/](https://SidRichardsQuantum.github.io/Shors_Algorithm_Simulation/)
6+
57
A pure Python implementation of Shor's quantum factorization algorithm using classical simulation of the period-finding step.
68
The project supports both explicit matrix simulation for very small inputs and a faster distribution-based simulation for the ideal first-register measurement probabilities.
79

@@ -22,11 +24,11 @@ The project supports both explicit matrix simulation for very small inputs and a
2224
Shor's algorithm is a quantum algorithm that efficiently finds the prime factors of large integers, which forms the basis for breaking RSA encryption.
2325
This implementation simulates the quantum operations classically to illustrate how Shor's algorithm works step by step. `mode="matrix"` explicitly applies the simulated gates and grows exponentially in memory; `mode="distribution"` computes the same ideal first-register probability distribution without materializing the full matrices.
2426

25-
See [THEORY.md](THEORY.md) for a descriptive algorithm walkthrough.
27+
See the [theory walkthrough](https://SidRichardsQuantum.github.io/Shors_Algorithm_Simulation/theory.html) for a descriptive algorithm walkthrough.
2628

27-
See [CIRCUITS.md](CIRCUITS.md) for the register and circuit-diagram walkthrough.
29+
See the [circuit walkthrough](https://SidRichardsQuantum.github.io/Shors_Algorithm_Simulation/circuits.html) for the register and circuit-diagram walkthrough.
2830

29-
See [RESULTS.md](RESULTS.md) for results and conclusions.
31+
See the [results page](https://SidRichardsQuantum.github.io/Shors_Algorithm_Simulation/results.html) for results and conclusions.
3032

3133
### Algorithm Steps
3234

0 commit comments

Comments
 (0)