<!--------------------------------------------------------------------------------------------------
Copyright 2024 Munich Quantum Software Stack Project

Licensed under the Apache License, Version 2.0 with LLVM Exceptions (the
"License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License at

https://github.com/Munich-Quantum-Software-Stack/MQSS-Quantum-Compilation-Suite/blob/develop/LICENSE

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.

SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
----------------------------------------------------------------------------------------------------->

# User Guide

<!-- Include the content of README.md between the pair of markers DOXYGEN MAIN. -->

This guide outlines the steps to build the project and generate the required targets. The scripts
required for building the targets can be found in `root/scripts/` directory. The `MakeFile` within
root is the one that invokes these scripts. Please check the following pages for more details.

```{toctree}
:maxdepth: 1
:caption: Contents

build
running
passes
library
transpiler
qdmi
```