Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #330

Merged
merged 3 commits into from
Aug 27, 2020
Merged

Update readme #330

merged 3 commits into from
Aug 27, 2020

Conversation

rmlarose
Copy link
Contributor

@rmlarose rmlarose commented Aug 26, 2020

Fixes #312 + the "spruce up readme" checklist todo I can't seem to find anymore.

Note I'm kinda guessing on which versions of Qiskit and pyQuil are supported. I know it works with Qiskit >= 0.19.0 and pyQuil >= 2.18.0, but earlier versions might be ok too.

@codecov
Copy link

codecov bot commented Aug 26, 2020

Codecov Report

Merging #330 into master will increase coverage by 0.19%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #330      +/-   ##
==========================================
+ Coverage   91.77%   91.97%   +0.19%     
==========================================
  Files          17       17              
  Lines         827      835       +8     
==========================================
+ Hits          759      768       +9     
+ Misses         68       67       -1     
Impacted Files Coverage Δ
mitiq/zne/scaling.py 96.53% <0.00%> (-0.34%) ⬇️
mitiq/benchmarks/utils.py 100.00% <0.00%> (ø)
mitiq/benchmarks/randomized_benchmarking.py 95.00% <0.00%> (ø)
mitiq/zne/inference.py 89.72% <0.00%> (+0.04%) ⬆️
mitiq/benchmarks/random_circuits.py 95.55% <0.00%> (+0.10%) ⬆️
mitiq/_about.py 59.25% <0.00%> (+3.25%) ⬆️
mitiq/_typing.py 100.00% <0.00%> (+18.18%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c041203...a35efdf. Read the comment docs.

README.md Outdated Show resolved Hide resolved
@nathanshammah
Copy link
Member

nathanshammah commented Aug 27, 2020

Thanks @rmlarose.
The readme is converted as rst in the documentation and then gives this page. In order for links to other (markdown) files in the repo to work also in the documentation, they need to be to the full URL link, not local, or they could point directly to the documentation version of such pages, e.g., https://mitiq.readthedocs.io/en/latest/toc_contributing.html.

Copy link
Member

@andreamari andreamari left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I suggested two changes which should fix the linking issue mentioned by @nathanshammah .

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
rmlarose and others added 2 commits August 27, 2020 12:39
Co-authored-by: Andrea Mari <[email protected]>
Co-authored-by: Andrea Mari <[email protected]>
@rmlarose rmlarose merged commit ab47ded into master Aug 27, 2020
@rmlarose rmlarose deleted the readme branch August 27, 2020 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add information in readme and documentation on installations of pyquil, qiskit for non devs
3 participants