Skip to content

Fix problems in README.md and make minor updates#907

Merged
mhucka merged 3 commits intoquantumlib:mainfrom
mhucka:mh-update-readme
Oct 24, 2025
Merged

Fix problems in README.md and make minor updates#907
mhucka merged 3 commits intoquantumlib:mainfrom
mhucka:mh-update-readme

Conversation

@mhucka
Copy link
Copy Markdown
Collaborator

@mhucka mhucka commented Oct 21, 2025

Changes:

  • There was a link at the top to a section titled "features", but there was no such section. Fixed by rearranging and rewriting the lead-in text to split it between an intro paragraph and a "features" section.

  • Remove mention of Conda. We currently don't have Conda builds.

  • The input format is deprecated. It was previously suggested to me to remove mention of it from the README. Done.

  • Removed the in-line BibTeX code in preference for using the approach we use in Cirq, which is to link to Zenodo.

  • Fix miscellaneous markdownlint warnings.

Changes:

* There was a link at the top to a section titled "features", but there
  was no such section. Fixed by rearranging and rewriting the lead-in
  text to split it between an intro paragraph and a "features" section.

* The input format is deprecated. It was previously suggested to me to
  remove mention of it from the README. Done.

* Removed the in-line BibTeX code in preference for using the approach
  we use in Cirq, which is to link to Zenodo.

* Fix miscellaneous markdownlint warnings.
@github-actions github-actions Bot added the size: M 50< lines changed <250 label Oct 21, 2025
github-merge-queue Bot pushed a commit that referenced this pull request Oct 22, 2025
For the time being, we are discontinuing the Conda distribution of
`qsimcirq`. This updates the installation instructions to omit mention
of Conda. (PR #907 takes care of
removing it from the top-level README.md file.)
Copy link
Copy Markdown
Collaborator

@sergeisakov sergeisakov left a comment

Choose a reason for hiding this comment

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

LGTM

Comment thread README.md Outdated
Per [review comment by
Sergei](https://github.com/quantumlib/qsim/pull/907/files#r2455610561),
we can remove the section about sample circuits since the input format
is being deprecated.
@mhucka mhucka added this pull request to the merge queue Oct 24, 2025
Merged via the queue into quantumlib:main with commit 9518ef2 Oct 24, 2025
28 checks passed
@mhucka mhucka deleted the mh-update-readme branch October 24, 2025 05:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size: M 50< lines changed <250

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants