Skip to content

Commit

Permalink
Update INSTALL.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vsoftco committed Nov 30, 2023
1 parent bd0075c commit 6fb91ce
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To build both tool suite and the **staq** executable, execute
cmake -B build
```

To be able to install staq's source code in addition to the binaries, configure
To be able to install **staq**'s source code in addition to the binaries, configure
the system with

```shell
Expand Down Expand Up @@ -94,18 +94,19 @@ or in an Administrator Command Prompt (Windows)
cmake --build build --target (un)install
```

If you configured the system with `-DINSTALL_SOURCES=ON`, staq's source
If you configured the system with `-DINSTALL_SOURCES=ON`, **staq**'s source
code will be installed in `/usr/local/include/staq` (UNIX/UNIX-like systems), or
in `C:\Program Files (x86)\staq` on Windows systems. The paths may differ on
your system. To use staq's source code, precede all include paths by `staq` in
your system. To use **staq**'s source code, precede all include paths by `staq` in
your own code, i.e.,

```c++
#include <staq/qasmtools/parser/parser.hpp>
```

Third party header-only libraries need to be preceded by `third_party` when
including their corresponding header file(s), i.e.,
Third party header-only libraries used internally by **staq** need to be
preceded by `third_party` when including their corresponding header file(s),
i.e.,

```c++
#include <staq/third_party/CLI/CLI.hpp>
Expand Down

0 comments on commit 6fb91ce

Please sign in to comment.