Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.

Commit 21934b3

Browse files
committed
Updated README.md
1 parent b779501 commit 21934b3

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

src/QirRuntime/README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ Running cmake from the editors will likely default to MSVC or clang-cl and fail.
4949

5050
See [https://code.visualstudio.com/docs/remote/wsl] on how to use VS Code with WSL.
5151

52+
#### Other Prerequisites
53+
The build depends on `Microsoft.Quantum.Simulator.Runtime` dynamic library built at a higher level of the directory tree.
54+
To build that library follow the instructions in [`qsharp-runtime/README.md`](../../README.md#building-from-source)
55+
(up to and including the step `Simulation.sln`).
56+
57+
5258
### Build Commands
5359
To build QirRuntime you can run [`build-qir-runtime.ps1`](build-qir-runtime.ps1) script from QirRuntime folder:
5460
```batch
@@ -63,34 +69,30 @@ because it is used by the continuous integration (CI) infrastructure, and this s
6369

6470
Or you can use CMake directly (not recommended). For example in Windows you can enter the following commands in the command line:
6571
```batch
66-
rem Navigate into QirRuntime folder.
72+
@rem Navigate to QirRuntime folder.
6773
68-
rem Creatge the `build` directory:
74+
@rem Creatge the `build` directory:
6975
mkdir build
7076
71-
rem Enter the `build` directory:
77+
@rem Enter the `build` directory:
7278
pushd build
7379
74-
rem Prepare for the build:
80+
@rem Prepare for the build:
7581
cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug ..
7682
77-
rem Build (you will likely need to issue this command several times, see issue #589):
83+
@rem Build (you will likely need to issue this command several times, see issue #589):
7884
cmake --build .
7985
80-
rem Return from the `build` directory:
86+
@rem Return from the `build` directory:
8187
popd
8288
```
8389
## Tests
8490

85-
### Prerequisites
86-
Some of the tests below depend on `Microsoft.Quantum.Simulator.Runtime` dynamic library built at a higher level of the directory tree.
87-
To build that library follow the instructions in [`qsharp-runtime/README.md`](../../README.md)
88-
(make sure to build the native simulator, see `quantum-simulator.sln` in that file,
89-
or provide your own version of the library in a folder the OS would search during dynamic library lookup).
90-
91-
### Running the Tests
91+
### Running All Tests
9292

9393
```batch
94+
@rem Navigate to QirRuntime folder.
95+
9496
pwsh test-qir-runtime.ps1
9597
```
9698
### Running Test Binaries Individually

0 commit comments

Comments
 (0)