diff --git a/samples/algorithms/README.md b/samples/algorithms/README.md index 42946a64e9ad..96d670d45463 100644 --- a/samples/algorithms/README.md +++ b/samples/algorithms/README.md @@ -1,7 +1,7 @@ # Algorithm Samples # - **[Simple Grover](./simple-grover)**: - This sample introduces Grover's algorithm for a simple hard-coded example. + This sample introduces Grover's algorithm for a simple hard-coded example. - **[Database Search](./database-search/)**: This sample demonstrates how to use Grover's algorithm to efficiently search a database represented as a quantum register. - **[Integer Factorization](./integer-factorization/)**: diff --git a/samples/algorithms/chsh-game/README.md b/samples/algorithms/chsh-game/README.md index cb63b0063800..07ac9824789e 100644 --- a/samples/algorithms/chsh-game/README.md +++ b/samples/algorithms/chsh-game/README.md @@ -46,8 +46,10 @@ dotnet run ### C# in Visual Studio 2019 -Open the folder containing this sample in Visual Studio ("Open a local folder" from the Getting Started screen or "File → Open → Folder..." from the menu bar) and set `CHSHGame.csproj` as the startup project. -Press Start in Visual Studio to run the sample. +Open the folder containing this sample in Visual Studio ("Open a local folder" +from the Getting Started screen or "File → Open → Folder..." from the menu bar) +and set `CHSHGame.csproj` as the startup project. +Press Start in Visual Studio to run the sample. ## Manifest diff --git a/samples/algorithms/database-search/README.md b/samples/algorithms/database-search/README.md index 7b61234ee0f3..00421c737ba6 100644 --- a/samples/algorithms/database-search/README.md +++ b/samples/algorithms/database-search/README.md @@ -9,7 +9,7 @@ Press Start in Visual Studio to run the sample. ## Running the Sample in Jupyter Notebook ## -This sample can also be viewed using Jupyter Notebook. +This sample can also be viewed using Jupyter Notebook. To do so, ensure that you have the IQ# kernel installed using the instructions in the [getting started guide](https://docs.microsoft.com/quantum/install-guide/jupyter). Then, start a new Jupyter Notebook session from this directory: diff --git a/samples/algorithms/integer-factorization/README.md b/samples/algorithms/integer-factorization/README.md index 7d117bca6ad5..8998ea216f5e 100644 --- a/samples/algorithms/integer-factorization/README.md +++ b/samples/algorithms/integer-factorization/README.md @@ -6,7 +6,7 @@ a part of Microsoft.Quantum.Canon library. ## Manifest ## -- [Shor.qs](./Shor.qs): Q# implementation of Shor's algorithm. +- [Shor.qs](./Shor.qs): Q# implementation of Shor's algorithm. - [Program.cs](./Program.cs): C# console application running Shor's algorithm on Quantum simulator - [IntegerFactorization.csproj](./IntegerFactorization.csproj): Main C# project for the sample. diff --git a/samples/algorithms/oracle-synthesis/README.md b/samples/algorithms/oracle-synthesis/README.md index 78c503e067c6..7450df6bd35a 100644 --- a/samples/algorithms/oracle-synthesis/README.md +++ b/samples/algorithms/oracle-synthesis/README.md @@ -24,7 +24,7 @@ ancillas](http://iopscience.iop.org/article/10.1088/1367-2630/16/3/033040/meta), ## Running the Sample ## -To run the sample, use the `dotnet run` command from your terminal. +To run the sample, use the `dotnet run` command from your terminal. ## Manifest diff --git a/samples/algorithms/order-finding/README.md b/samples/algorithms/order-finding/README.md index f494ad842d2f..c06bdd76ac82 100644 --- a/samples/algorithms/order-finding/README.md +++ b/samples/algorithms/order-finding/README.md @@ -14,7 +14,7 @@ in the C# file is restricted to permutations over 4 elements. ## Running the Sample ## Open the `QsharpSamples.sln` solution in Visual Studio and set *Samples / 1. Algorithms / OrderFinding* as the startup project. -Press Start in Visual Studio to run the sample. +Press Start in Visual Studio to run the sample. ## Manifest ## diff --git a/samples/arithmetic/README.md b/samples/arithmetic/README.md index 48fb38c6ade0..de1654e157ba 100644 --- a/samples/arithmetic/README.md +++ b/samples/arithmetic/README.md @@ -11,7 +11,7 @@ To start the Jupyter Notebook use the following command in this directory. ``` PS> jupyter notebook AdderExample.ipynb ``` -Use the `Run` button to walk through the notebook line by line. +Use the `Run` button to walk through the notebook line by line. ## Manifest ## diff --git a/samples/characterization/phase-estimation/README.md b/samples/characterization/phase-estimation/README.md index 7bde9636ad65..fe3a6947dd73 100644 --- a/samples/characterization/phase-estimation/README.md +++ b/samples/characterization/phase-estimation/README.md @@ -20,7 +20,7 @@ This sample demonstrates iterative phase estimation using Bayesian inference to This sample can be run in a number of different ways, depending on your preferred environment. -To run the sample, use the `dotnet run` command from your terminal. +To run the sample, use the `dotnet run` command from your terminal. ## Manifest diff --git a/samples/chemistry/IntegralData/README.md b/samples/chemistry/IntegralData/README.md index 6e55ec87e6ec..eead3c68bffd 100644 --- a/samples/chemistry/IntegralData/README.md +++ b/samples/chemistry/IntegralData/README.md @@ -3,7 +3,7 @@ Orbital integrals in YAML/ are generated by NWChem yaml branch. # Integral Data for Chemistry Hamiltonians # -This contains integral data describing a variety of chemistry Hamiltonians. +This contains integral data describing a variety of chemistry Hamiltonians. ## Data sources diff --git a/samples/chemistry/PythonIntegration/README.md b/samples/chemistry/PythonIntegration/README.md index 5b7b67c013b5..10ecd4507046 100644 --- a/samples/chemistry/PythonIntegration/README.md +++ b/samples/chemistry/PythonIntegration/README.md @@ -25,7 +25,7 @@ The first time you run the sample you might see errors like this when the script fail: Microsoft.Quantum.IQSharp.Workspace[0] QS5022: No identifier with that name exists. ``` -these are known and are safe to ignore. +these are known and are safe to ignore. If the script runs successfully, you should see this message in the output. ``` diff --git a/samples/chemistry/README.md b/samples/chemistry/README.md index 6efac83033fa..efad2bf81ad3 100644 --- a/samples/chemistry/README.md +++ b/samples/chemistry/README.md @@ -1,6 +1,6 @@ # Quantum Chemistry Library Samples # -These samples demonstrate the use of the Quantum Chemistry library. +These samples demonstrate the use of the Quantum Chemistry library. Each sample is provided as a Visual Studio 2019 C# or project in their respective directories. Each of these samples are described below. Most of the samples consist of a Q# source file with detailed comments explaining the sample and a commented classical program `Program.cs` to call into Q# operations and functions. diff --git a/samples/diagnostics/README.md b/samples/diagnostics/README.md index 5595810455ad..4ec4159dd177 100644 --- a/samples/diagnostics/README.md +++ b/samples/diagnostics/README.md @@ -1,6 +1,6 @@ # Diagnostics and Testing Samples # -These samples show how to diagnose and test Q# applications. +These samples show how to diagnose and test Q# applications. - **[Unit Testing](./unit-testing)**: This sample demonstrates how to use the unit testing functionality provided with the Quantum Development Kit to test the correctness of quantum programs. diff --git a/samples/error-correction/README.md b/samples/error-correction/README.md index 6c4294e1db3f..6d1fe80436b0 100644 --- a/samples/error-correction/README.md +++ b/samples/error-correction/README.md @@ -4,3 +4,4 @@ These samples show how to work with quantum error correcting codes in Q# program - **[Bit-flip Code](./bit-flip-code)**: This sample describes a simple quantum code that encodes 1 qubit into 3 qubits and protects against a single bit-flip error. + \ No newline at end of file diff --git a/samples/error-correction/bit-flip-code/README.md b/samples/error-correction/bit-flip-code/README.md index 1c7d8b06c66e..a2d3b09b799e 100644 --- a/samples/error-correction/bit-flip-code/README.md +++ b/samples/error-correction/bit-flip-code/README.md @@ -11,7 +11,7 @@ urlFragment: bit-flip-code # Bit-flip Quantum Code Sample -This sample demonstrates: +This sample demonstrates: - Using the Q# standard libraries to implement a simple quantum error correction code. diff --git a/samples/getting-started/intro-to-iqsharp/README.md b/samples/getting-started/intro-to-iqsharp/README.md index 4e667424ad01..d08f1f7a635f 100644 --- a/samples/getting-started/intro-to-iqsharp/README.md +++ b/samples/getting-started/intro-to-iqsharp/README.md @@ -16,7 +16,7 @@ This sample demonstrates: ## Prerequisites - The Microsoft [Quantum Development Kit](https://docs.microsoft.com/quantum/install-guide/). -- Jupyter Notebook +- Jupyter Notebook ## Running the Sample diff --git a/samples/getting-started/measurement/README.md b/samples/getting-started/measurement/README.md index 0bb0939e28f1..fe53b21c1847 100644 --- a/samples/getting-started/measurement/README.md +++ b/samples/getting-started/measurement/README.md @@ -24,7 +24,7 @@ In this sample, we show how `M` can be used to sample random numbers, and to mea ## Running the Sample -To run the sample, use the `dotnet run` command from your terminal. +To run the sample, use the `dotnet run` command from your terminal. ## Manifest diff --git a/samples/getting-started/qrng/README.md b/samples/getting-started/qrng/README.md index 888fb952aa21..efca6028af9f 100644 --- a/samples/getting-started/qrng/README.md +++ b/samples/getting-started/qrng/README.md @@ -11,9 +11,9 @@ description: "This sample implements a quantum random number generator using Q#, This sample implements a quantum random number generator, a very simple application that is useful to learn how to write a first Q# program. -In the Q# code (Qrng.qs) you will find the Q# operation for extracting a random bit using quantum measurements over a qubit in superposition. For more information, you can take a look at the [full tutorial](https://docs.microsoft.com/quantum/quickstarts/qrng). +In the Q# code (Qrng.qs) you will find the Q# operation for extracting a random bit using quantum measurements over a qubit in superposition. For more information, you can take a look at the [full tutorial](https://docs.microsoft.com/quantum/quickstarts/qrng). -You will also find a Q# operation that creates a random integer from 0 to a maximum integer by invoking several times the Q# operation for extracting a random bit. +You will also find a Q# operation that creates a random integer from 0 to a maximum integer by invoking several times the Q# operation for extracting a random bit. ## Prerequisites ## @@ -21,7 +21,7 @@ You will also find a Q# operation that creates a random integer from 0 to a maxi ## Running the Sample ## -To run the sample, use the `dotnet run` command from your terminal. +To run the sample, use the `dotnet run` command from your terminal. ## Manifest ## diff --git a/samples/getting-started/simple-algorithms/README.md b/samples/getting-started/simple-algorithms/README.md index 17d1ca40a62e..8031579259c0 100644 --- a/samples/getting-started/simple-algorithms/README.md +++ b/samples/getting-started/simple-algorithms/README.md @@ -18,7 +18,7 @@ This sample describes three simple quantum algorithms: the Bernstein–Vazirani ## Running the Sample -To run the sample, use the `dotnet run` command from your terminal. +To run the sample, use the `dotnet run` command from your terminal. ## Manifest diff --git a/samples/getting-started/teleportation/README.md b/samples/getting-started/teleportation/README.md index c296d7261699..3c16db50aeec 100644 --- a/samples/getting-started/teleportation/README.md +++ b/samples/getting-started/teleportation/README.md @@ -18,7 +18,7 @@ This sample demonstrates the use of the Quantum Development Kit for quantum tele ## Running the Sample -To run the sample, use the `dotnet run` command from your terminal. +To run the sample, use the `dotnet run` command from your terminal. ## Manifest ## diff --git a/samples/interoperability/dotnet/README.md b/samples/interoperability/dotnet/README.md index 0c207a02a055..a640991c317a 100644 --- a/samples/interoperability/dotnet/README.md +++ b/samples/interoperability/dotnet/README.md @@ -20,7 +20,7 @@ The steps are as follows: This will transitively include the [`Microsoft.Quantum.Development.Kit` NuGet package](https://www.nuget.org/packages/Microsoft.Quantum.Development.Kit) to your C# or F# application. You will not be writing any Q# code in `csharp.csproj` or `fsharp.fsproj`, but you will need to use functionality provided by the Quantum Development Kit to create a quantum simulator to run your quantum code on, and to define data types used to pass the parameters to your quantum program. -4. Write the classical host program in your .NET application. +4. Write the classical host program in your .NET application. ## Q# Code in the Sample diff --git a/samples/interoperability/python/README.md b/samples/interoperability/python/README.md index 0dbae7157986..75799b3314f7 100644 --- a/samples/interoperability/python/README.md +++ b/samples/interoperability/python/README.md @@ -23,7 +23,8 @@ Once everything is installed, run `jupyter notebook` to start the Jupyter Notebo PS> jupyter notebook ``` -In the browser, select the `tomography-sample.ipynb` notebook in your browser to view the sample. +In the browser, select the `tomography-sample.ipynb` notebook in your browser to +view the sample. ## Manifest ## diff --git a/samples/interoperability/qrng/README.md b/samples/interoperability/qrng/README.md index 41af4920d903..3aa49d2c1bd6 100644 --- a/samples/interoperability/qrng/README.md +++ b/samples/interoperability/qrng/README.md @@ -45,7 +45,7 @@ dotnet run ### C# in Visual Studio 2019 ### Open the folder containing this sample in Visual Studio ("Open a local folder" from the Getting Started screen or "File → Open → Folder..." from the menu bar) and set `Qrng.csproj` as the startup project. -Press Start in Visual Studio to run the sample. +Press Start in Visual Studio to run the sample. ## Manifest ## diff --git a/samples/machine-learning/half-moons/README.md b/samples/machine-learning/half-moons/README.md index 1beed56e960a..5e433e7513db 100644 --- a/samples/machine-learning/half-moons/README.md +++ b/samples/machine-learning/half-moons/README.md @@ -42,7 +42,7 @@ dotnet run ### C# in Visual Studio 2019 Open the folder containing this sample in Visual Studio ("Open a local folder" from the Getting Started screen or "File → Open → Folder..." from the menu bar) and set `HalfMoons.csproj` as the startup project. -Press Start in Visual Studio to run the sample. +Press Start in Visual Studio to run the sample. ## Manifest diff --git a/samples/machine-learning/parallel-half-moons/README.md b/samples/machine-learning/parallel-half-moons/README.md index bb47e9627073..456774b59f98 100644 --- a/samples/machine-learning/parallel-half-moons/README.md +++ b/samples/machine-learning/parallel-half-moons/README.md @@ -36,7 +36,7 @@ dotnet run ### C# in Visual Studio 2019 Open the folder containing this sample in Visual Studio ("Open a local folder" from the Getting Started screen or "File → Open → Folder..." from the menu bar) and set `HalfMoons.csproj` as the startup project. -Press Start in Visual Studio to run the sample. +Press Start in Visual Studio to run the sample. ## Manifest diff --git a/samples/machine-learning/wine/README.md b/samples/machine-learning/wine/README.md index 4e48fb167178..bd8204aa2fa1 100644 --- a/samples/machine-learning/wine/README.md +++ b/samples/machine-learning/wine/README.md @@ -42,7 +42,7 @@ dotnet run ### C# in Visual Studio 2019 Open the folder containing this sample in Visual Studio ("Open a local folder" from the Getting Started screen or "File → Open → Folder..." from the menu bar) and set `Wine.csproj` as the startup project. -Press Start in Visual Studio to run the sample. +Press Start in Visual Studio to run the sample. ## Manifest diff --git a/samples/numerics/README.md b/samples/numerics/README.md index c76d72900fe8..4fafa52dd248 100644 --- a/samples/numerics/README.md +++ b/samples/numerics/README.md @@ -4,7 +4,7 @@ The samples in this folder show how to use the numerics library. The `CustomModAdd` sample illustrates how to implement a custom modular addition operation. The `EvaluatingFunctions` sample shows how to evaluate smooth functions using a polynomial approximation in fixed-point arithmetic and `ResourceCounting` counts the resources of this -operation. +operation. ## Running the Samples diff --git a/samples/runtime/reversible-simulator/README.md b/samples/runtime/reversible-simulator/README.md index bc986f59fe2e..f88fcc23efe5 100644 --- a/samples/runtime/reversible-simulator/README.md +++ b/samples/runtime/reversible-simulator/README.md @@ -43,7 +43,7 @@ dotnet run Open the folder containing this sample in Visual Studio ("Open a local folder" from the Getting Started screen or "File → Open → Folder..." from the menu bar) and set `ReversibleSimulator.csproj` as the startup project. Press Start in -Visual Studio to run the sample. +Visual Studio to run the sample. ## Manifest ## diff --git a/samples/runtime/simulator-with-overrides/README.md b/samples/runtime/simulator-with-overrides/README.md index 3aa3fa5c85e6..46cb3ba64bf1 100644 --- a/samples/runtime/simulator-with-overrides/README.md +++ b/samples/runtime/simulator-with-overrides/README.md @@ -32,7 +32,7 @@ dotnet run ### C# in Visual Studio 2019 Open the folder containing this sample in Visual Studio ("Open a local folder" from the Getting Started screen or "File → Open → Folder..." from the menu bar) and set `SimulatorWithOverrides.csproj` as the startup project. -Press Start in Visual Studio to run the sample. +Press Start in Visual Studio to run the sample. ## Manifest diff --git a/samples/simulation/hubbard/README.md b/samples/simulation/hubbard/README.md index 5d54c3b1888d..05f656550bba 100644 --- a/samples/simulation/hubbard/README.md +++ b/samples/simulation/hubbard/README.md @@ -19,7 +19,7 @@ This time-evolution operator is applied to project onto the ground state of the ## Running the Sample -To run the sample, use the `dotnet run` command from your terminal. +To run the sample, use the `dotnet run` command from your terminal. ## Manifest ##