Skip to content

Commit ca18944

Browse files
authored
📝 Add documentation badge and stabilize banner image link (#12)
## Description This pull request adds a documentation build badge to the project for better visibility of the documentation status. Additionally, it updates the banner to point to a stable image link, ensuring the banner displays correctly in the rendered PyPI README. ## Checklist: - [x] The pull request only contains commits that are related to it. - [x] I have added appropriate tests and documentation. - [x] I have made sure that all CI jobs on GitHub pass. - [x] The pull request introduces no new warnings and follows the project's style
1 parent 9a2a6e1 commit ca18944

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,12 @@
33
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://opensource.org/licenses/MIT)
44
[![CI](https://img.shields.io/github/actions/workflow/status/cda-tum/mqt-yaqs/ci.yml?branch=main&style=flat-square&logo=github&label=ci)](https://github.com/cda-tum/mqt-yaqs/actions/workflows/ci.yml)
55
[![CD](https://img.shields.io/github/actions/workflow/status/cda-tum/mqt-yaqs/cd.yml?style=flat-square&logo=github&label=cd)](https://github.com/cda-tum/mqt-yaqs/actions/workflows/cd.yml)
6+
[![Documentation](https://img.shields.io/readthedocs/mqt-yaqs?logo=readthedocs&style=flat-square)](https://mqt.readthedocs.io/projects/yaqs)
67
[![codecov](https://img.shields.io/codecov/c/github/cda-tum/mqt-yaqs?style=flat-square&logo=codecov)](https://codecov.io/gh/cda-tum/mqt-yaqs)
78

8-
![Banner](images/banner.jpeg)
9+
<picture>
10+
<img src="https://raw.githubusercontent.com/cda-tum/mqt-yaqs/main/images/banner.jpeg" width="95%" alt="MQT YAQS Banner">
11+
</picture>
912

1013
# MQT YAQS: A Tool for Simulating Open Quantum Systems, Noisy Quantum Circuits, and Realistic Quantum Hardware
1114

0 commit comments

Comments
 (0)