unitaryfund / mitiq

Mitiq is an open source toolkit for implementing error mitigation techniques on most current intermediate-scale quantum computers.
https://mitiq.readthedocs.io
GNU General Public License v3.0
344 stars 145 forks source link

Update readme #2421

Closed purva-thakre closed 3 days ago

purva-thakre commented 6 days ago

Description

Fixes #2417 Fixes #2388


License

Before opening the PR, please ensure you have completed the following where appropriate.

codecov[bot] commented 6 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.32%. Comparing base (20732a0) to head (2fe9b34). Report is 2 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #2421 +/- ## ======================================= Coverage 98.32% 98.32% ======================================= Files 87 87 Lines 4048 4048 ======================================= Hits 3980 3980 Misses 68 68 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

purva-thakre commented 5 days ago

IDK how to fix the broken logo in both the md and the sphinx files at the same time. I had to add ../../ to the relative path to verify the output of make docs locally.

Sphinx requires a relative path to where the logo is (screenshot from RTD).

image

But the .md file has the broken logo.

https://github.com/unitaryfund/mitiq/blob/9f84e0bb7c9f2b0077da186a305f6bb958bae774/README.md#supported-frontends image

purva-thakre commented 4 days ago

Disregard my previous comment. I linked the png image directly without having to worry about the relative path.