Expand and embellish README file#1601
Conversation
In Markdown, two trailing spaces on a line are a shorthand way to indicate a forced line break. This is prone to causing problems accidentally, so as a safety precaution, it's a good idea to remove any whitespace at the ends of lines.
Google requires the text of this disclaimer in project README files for open-source projects.
It's pretty, and it's good for branding.
Changes: * Add required Google disclaimer * Add new "Usage", "News" & "Contact" sections * Move some text around * Use GitHub Markdown syntax for warning boxes * Add a TOC line near the top, for rapid access * Add logos and badges, for some extra visual flair
mhucka
force-pushed
the
mh-update-readme
branch
from
f8618d9 to
7b91739
Compare
|
Here are screenshots of what the README file looks like after the changes. 
|
The section "How to cite" appears in a number of other Quantumlib READMEs, and URLs referencing #how-to-cite exist in some documens, so for maximum compatibility, let's add an additional anchor for links.
| programs and a library of quantum algorithms expressed in that language to support quantum | ||
| algorithms research. | ||
|
|
||
| **Note:** Qualtran is an experimental preview release. We provide no backwards compatibility |
There was a problem hiding this comment.
@mpharrigan shall we update this to align better with the stability of versions released 09.2024 onwards
| Documentation is available at https://qualtran.readthedocs.io/ | ||
| </div> | ||
|
|
||
| Qualtran (_quantum algorithms translator_) is a set of abstractions for representing quantum |
There was a problem hiding this comment.
let's remove the "quantum algorithms translator" parenthetical while we're at it. The name "qualtran" isn't an abbreviation for anything. This was trying to explain the joke; which has already been neutered by no longer using the small caps :)
There was a problem hiding this comment.
I feel like I had a hand in destroying the small caps, which I'm sorry about.
But, honestly, Qualtran = "quantum algorithms translator" wouldn't be bad, would it? Better than many software names I've been guilty of making in the past (e.g., https://github.com/caltechlibrary/baler#readme, https://github.com/caltechlibrary/handprint#readme, etc.)
There was a problem hiding this comment.
you put small caps out of its dying misery
abandoning the confusing "is this an abbreviation" halfway through would continue to pay homage to our forefathers
There was a problem hiding this comment.
I feel like some solemn music should be played right about now.
There was a problem hiding this comment.
Alright, the parenthetical remark is gone in the latest commit.
I also did the last thing I wanted to do, which is improve the way the logo handles dark mode/light mode. Unless I hear otherwise, I'll merge the changes today at 3:00 PST.
Per [review comment by @mpharrigan](quantumlib#1601 (comment)), removing the mention of the physical resources estimation GUI.
Following up on a suggestion in a [review comment by @mpharrigan](quantumlib#1601 (comment)) to put the Qualtran title in comment at the top of the file.
|
Screenshots of how it looks like currently, for reference: 
|
Using a trick from https://stackoverflow.com/a/67190894/743730, we can create a single SVG that will change text colors depending on whether the user is using dark mode or light mode on GitHub.
Because it isn't.
3 participants
Changes: