mqt-core icon indicating copy to clipboard operation
mqt-core copied to clipboard

🎨 Restructure README.md and index.md

Open ystade opened this issue 1 year ago • 4 comments

Description

This PR restructures the README.md as well as the index.md for RtD. In particular,

  • it moves the contributors and supporters logos further down,
  • clarifies the roles of the contributors, supporters, and projects,
  • and moves the BibTeX ref to the end of the page.

Checklist:

  • [x] The pull request only contains commits that are focused and relevant to this change.
  • ~~I have added appropriate tests that cover the new/changed functionality.~~
  • ~~I have updated the documentation to reflect these changes.~~
  • ~~I have added entries to the changelog for any noteworthy additions, changes, fixes or removals.~~
  • ~~I have added migration instructions to the upgrade guide (if needed).~~
  • [x] The changes follow the project's style guidelines and introduce no new warnings.
  • ~~The changes are fully tested and pass the CI checks.~~
  • [x] I have reviewed my own code changes.

ystade avatar May 15 '25 11:05 ystade

The banner is not yet displayed correctly, as the PR in the other repo must first be merged.

ystade avatar May 15 '25 11:05 ystade

The banner is not yet displayed correctly, as the PR in the other repo must first be merged.

You could point to the specific branch for the image to be displayed correctly, while we fine-tune this PR.

burgholzer avatar May 15 '25 11:05 burgholzer

You could point to the specific branch for the image to be displayed correctly, while we fine-tune this PR.

Yes, but then someone would need to change it back for the final version. I see the danger us forgetting it.

ystade avatar May 15 '25 11:05 ystade

You could point to the specific branch for the image to be displayed correctly, while we fine-tune this PR.

Yes, but then someone would need to change it back for the final version. I see the danger us forgetting it.

Agreed. We can just test this in the MQT Repository itself. I will propose something.

burgholzer avatar May 15 '25 11:05 burgholzer