Slightly update README file and spiff up formatting#768
Conversation
The way sections were arranged in the REAMDE file left lacked hierarchical consistency. In addition, there was not much of an introduction, which could leave new visitors a bit confused. I made the section structure more hierarchical, moved a section or two around for better logical flow, and added the usual badges and other visual elements at the top.
mhucka
force-pushed
the
mh-update-readme
branch
2 times, most recently
from
f29c19e to
d9db759
Compare
|
|
||
| </div> | ||
|
|
||
| _qsim_ and _qsimh_ are Schrödinger and Schrödinger-Feynman state vector |
There was a problem hiding this comment.
Is qsimh still a thing? I thought that disappeared years ago. (maybe I am thinking of a different one though?).
There was a problem hiding this comment.
Is qsimh still a thing? I thought that disappeared years ago. (maybe I am thinking of a different one though?).
Hmm. I will check.
There was a problem hiding this comment.
Update: qsimh is indeed no longer used. I've updated this PR to remove mention of qsimh from the README and will open a ticket to remind us to delete it from the rest of the distribution.
| ### Input format | ||
|
|
||
| > [!WARNING] | ||
| > This format is deprecated, and no longer actively maintained. |
There was a problem hiding this comment.
Should we drop it from the docs if it is no longer maintained?
There was a problem hiding this comment.
Should we drop it from the docs if it is no longer maintained?
That would be better. I'll remove mention from the README; however, it's probably best to leave the description somewhere in the docs themselves, in case there's some (old) software that still uses it. I'll add the notes about deprecation wherever it's mentioned in the rest of the docs.
I need to also check if the builds & tests make use of this format and deal with those.
There was a problem hiding this comment.
I take it back: there are examples in the docs that use the input format, and it would take time to figure out how to update things. In the interest of trying to get this release out, I'll open an issue instead, and deal with this for the next release (unless you have strong objections, @dstrain115).
mhucka
changed the title
I found it hard to scan the text in that intro due to the way that the references were formatted. It seems good enough to put them inline, so I did.
3 participants
The way sections were arranged in the README file left lacked hierarchical consistency. In addition, there was not much of an introduction, which could leave new visitors a bit confused. I made the section structure more hierarchical, moved a section or two around for better logical flow, and added the usual badges and other visual elements at the top.
A formatted version of this updated README can be seen at https://github.com/quantumlib/qsim/blob/mh-update-readme/README.md