You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## Description
This PR prepares the move to the MQT organization.
- Streamline the README.
- Streamline the documentation. Remove work-in-progress files.
Documentation will be added with #103.
- Slightly off topic, but test GitHub Pages build in PRs.
## Checklist:
- [x] The pull request only contains commits that are focused and
relevant to this change.
- [x] ~I have added appropriate tests that cover the new/changed
functionality.~
- [x] ~I have updated the documentation to reflect these changes.~
- [x] The changes follow the project's style guidelines and introduce no
new warnings.
- [x] The changes are fully tested and pass the CI checks.
- [x] I have reviewed my own code changes.
---------
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,24 +5,24 @@ We value contributions from people with all levels of experience.
5
5
In particular if this is your first pull request not everything has to be perfect.
6
6
We will guide you through the process.
7
7
8
-
We use GitHub to [host code](https://github.com/cda-tum/mqt-naviz), to [track issues and feature requests](https://github.com/cda-tum/mqt-naviz/issues), as well as accept [pull requests](https://github.com/cda-tum/mqt-naviz/pulls).
8
+
We use GitHub to [host code](https://github.com/munich-quantum-toolkit/naviz), to [track issues and feature requests](https://github.com/munich-quantum-toolkit/naviz/issues), as well as accept [pull requests](https://github.com/munich-quantum-toolkit/naviz/pulls).
9
9
See <https://docs.github.com/en/get-started/quickstart> for a general introduction to working with GitHub and contributing to projects.
10
10
11
11
## Types of Contributions
12
12
13
13
You can contribute in several ways:
14
14
15
15
- 🐛 Report Bugs
16
-
: Report bugs at <https://github.com/cda-tum/mqt-naviz/issues> using the _🐛 Bug report_ issue template. Please make sure to fill out all relevant information in the respective issue form.
16
+
: Report bugs at <https://github.com/munich-quantum-toolkit/naviz/issues> using the _🐛 Bug report_ issue template. Please make sure to fill out all relevant information in the respective issue form.
17
17
18
18
- 🐛 Fix Bugs
19
-
: Look through the [GitHub Issues](https://github.com/cda-tum/mqt-naviz/issues) for bugs. Anything tagged with "bug" is open to whoever wants to try and fix it.
19
+
: Look through the [GitHub Issues](https://github.com/munich-quantum-toolkit/naviz/issues) for bugs. Anything tagged with "bug" is open to whoever wants to try and fix it.
20
20
21
21
- ✨ Propose New Features
22
-
: Propose new features at <https://github.com/cda-tum/mqt-naviz/issues> using the _✨ Feature request_ issue template. Please make sure to fill out all relevant information in the respective issue form.
22
+
: Propose new features at <https://github.com/munich-quantum-toolkit/naviz/issues> using the _✨ Feature request_ issue template. Please make sure to fill out all relevant information in the respective issue form.
23
23
24
24
- ✨ Implement New Features
25
-
: Look through the [GitHub Issues](https://github.com/cda-tum/mqt-naviz/issues) for features. Anything tagged with "feature" or "enhancement" is open to whoever wants to implement it. We highly appreciate external contributions to the project.
25
+
: Look through the [GitHub Issues](https://github.com/munich-quantum-toolkit/naviz/issues) for features. Anything tagged with "feature" or "enhancement" is open to whoever wants to implement it. We highly appreciate external contributions to the project.
26
26
27
27
- 📝 Write Documentation
28
28
: MQT NAViz could always use some more documentation, and we appreciate any help with that.
If you are stuck with a problem using MQT NAViz or have questions, please get in touch at our [Issues](https://github.com/cda-tum/mqt-naviz/issues) or [Discussions](https://github.com/cda-tum/mqt-naviz/discussions). We'd love to help.
3
+
If you are stuck with a problem using MQT NAViz or have questions, please get in touch at our [Issues](https://github.com/munich-quantum-toolkit/naviz/issues) or [Discussions](https://github.com/munich-quantum-toolkit/naviz/discussions). We'd love to help.
4
4
5
5
You can save time by following this procedure when reporting a problem:
6
6
7
7
- Do try to solve the problem on your own first.
8
-
- Search through past [Issues](https://github.com/cda-tum/mqt-naviz/issues) and [Discussions](https://github.com/cda-tum/mqt-naviz/discussions) to see if someone else already had the same problem.
8
+
- Search through past [Issues](https://github.com/munich-quantum-toolkit/naviz/issues) and [Discussions](https://github.com/munich-quantum-toolkit/naviz/discussions) to see if someone else already had the same problem.
9
9
- Before filing a bug report, try to create a minimal working example (MWE) that reproduces the problem. It is much easier to identify the cause for the problem if a handful of lines suffice to show that something is not working.
@@ -35,7 +29,7 @@ It is developed as part of the [_Munich Quantum Toolkit (MQT)_](https://mqt.read
35
29
- Support for different input formats
36
30
- Fully customizable visualization style and clean predefined styles
37
31
38
-
If you have any questions, feel free to create a [discussion](https://github.com/cda-tum/mqt-naviz/discussions) or an [issue](https://github.com/cda-tum/mqt-naviz/issues) on [GitHub](https://github.com/cda-tum/mqt-naviz).
32
+
If you have any questions, feel free to create a [discussion](https://github.com/munich-quantum-toolkit/naviz/discussions) or an [issue](https://github.com/munich-quantum-toolkit/naviz/issues) on [GitHub](https://github.com/munich-quantum-toolkit/naviz).
39
33
40
34
## Contributors and Supporters
41
35
@@ -52,11 +46,46 @@ Among others, it is part of the [Munich Quantum Software Stack (MQSS)](https://w
52
46
Thank you to all the contributors who have helped make MQT NAViz a reality!
<imgwidth=20%src="https://img.shields.io/badge/Sponsor-white?style=for-the-badge&logo=githubsponsors&labelColor=black&color=blue"alt="Sponsor the MQT" />
68
+
</a>
69
+
</p>
70
+
71
+
## Cite This
72
+
73
+
When discussing the overall MQT project or its ecosystem, please cite the MQT Handbook:
74
+
75
+
```bibtex
76
+
@inproceedings{mqt,
77
+
title = {The {{MQT}} Handbook: {{A}} Summary of Design Automation Tools and Software for Quantum Computing},
78
+
shorttitle = {{The MQT Handbook}},
79
+
author = {Will, Robert and Berent, Lucas and Forster, Tobias and Kunasaikaran, Jagatheesan and Mato, Kevin and Peham, Tom and Quetschlich, Nils and Rovara, Damian and Sander, Aaron and Schmid, Ludwig and Schoenberger, Daniel and Stade, Yannick and Burgholzer, Lukas},
80
+
year = 2024,
81
+
booktitle = {IEEE International Conference on Quantum Software (QSW)},
82
+
doi = {10.1109/QSW62656.2024.00013},
83
+
eprint = {2405.17543},
84
+
eprinttype = {arxiv},
85
+
addendum = {A live version of this document is available at \url{https://mqt.readthedocs.io}}
0 commit comments