Skip to content

Commit

Permalink
📝 update RtD files
Browse files Browse the repository at this point in the history
  • Loading branch information
burgholzer committed Aug 11, 2023
1 parent 3ce3bda commit 7d1347f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions docs/source/DevelopmentGuide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ Ready to contribute to the project? Here is how to set up a local development en
Initial Setup
#############

1. Fork the `cda-tum/qmap <https://github.com/cda-tum/qmap>`_ repository on GitHub (see https://docs.github.com/en/get-started/quickstart/fork-a-repo).
1. Fork the `cda-tum/mqt-qmap <https://github.com/cda-tum/mqt-qmap>`_ repository on GitHub (see https://docs.github.com/en/get-started/quickstart/fork-a-repo).

2. Clone your fork locally

.. code-block:: console
$ git clone [email protected]:your_name_here/qmap --recursive
$ git clone [email protected]:your_name_here/mqt-qmap --recursive
.. warning::

Expand All @@ -23,7 +23,7 @@ Initial Setup

.. code-block:: console
$ cd qmap
$ cd mqt-qmap
4. Create a branch for local development

Expand Down
4 changes: 2 additions & 2 deletions docs/source/Installation.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Installation
============

QMAP is mainly developed as a C++ library that builds upon `our quantum functionality representation (QFR) <https://github.com/cda-tum/qfr>`_.
QMAP is mainly developed as a C++ library that builds upon `MQT Core <https://github.com/cda-tum/mqt-core>`_, which forms the backbone of the `MQT <https://mqt.readthedocs.io>`_.
In order to make the tool as accessible as possible, it comes with an easy-to-use Python interface.

We encourage installing QMAP via pip (preferably in a `virtual environment <https://docs.python.org/3/library/venv.html>`_):
Expand Down Expand Up @@ -118,7 +118,7 @@ This requires a `C++ compiler <https://en.wikipedia.org/wiki/List_of_compilers#C
- Build Z3 from source and install it to the system

The library is continuously tested under Linux, MacOS, and Windows using the `latest available system versions for GitHub Actions <https://github.com/actions/virtual-environments>`_.
In order to access the latest build logs, visit `qmap/actions/workflows/ci.yml <https://github.com/cda-tum/qmap/actions/workflows/ci.yml>`_.
In order to access the latest build logs, visit `mqt-qmap/actions/workflows/ci.yml <https://github.com/cda-tum/mqt-qmap/actions/workflows/ci.yml>`_.

.. note::
We noticed some issues when compiling with Microsoft's *MSCV* compiler toolchain. If you want to start development on this project under Windows, consider using the *clang* compiler toolchain. A detailed description of how to set this up can be found `here <https://docs.microsoft.com/en-us/cpp/build/clang-support-msbuild?view=msvc-160>`_.
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Welcome to QMAP's documentation!
================================

QMAP is a tool for quantum circuit compilation developed as part of the *Munich Quantum Toolkit* (*MQT*) [#]_ by the `Chair for Design Automation <https://www.cda.cit.tum.de/>`_ at the `Technical University of Munich <https://www.tum.de>`_. It builds upon `our quantum functionality representation (QFR) <https://github.com/cda-tum/qfr>`_.
QMAP is a tool for quantum circuit compilation developed as part of the `Munich Quantum Toolkit <https://mqt.readthedocs.io>`_ (*MQT*) [#]_ by the `Chair for Design Automation <https://www.cda.cit.tum.de/>`_ at the `Technical University of Munich <https://www.tum.de>`_. It builds upon `MQT Core <https://github.com/cda-tum/mqt-core>`_, which forms the backbone of the MQT.

We recommend you to start with the :doc:`installation instructions <Installation>` or by reading our overview paper :cite:labelpar:`wille2023qmap`.
Then proceed to the :doc:`mapping page <Mapping>` or the :doc:`synthesis/optimization page <Synthesis>` and read the :doc:`reference documentation <library/Library>`.
Expand Down

0 comments on commit 7d1347f

Please sign in to comment.