-
Notifications
You must be signed in to change notification settings - Fork 201
Slightly update README file and spiff up formatting #768
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
bb52d66
Adjust and spiff up README format
mhucka b26ae21
Change the note to a warning
mhucka 5d4ba49
Merge branch 'master' into mh-update-readme
mhucka 83b4011
Merge branch 'master' into mh-update-readme
mhucka 12483a5
Remove mention of qsimh & adjust text
mhucka 4928688
Add more info to the Python installation instructions
mhucka 538f26b
Merge branch 'master' into mh-update-readme
mhucka 59a4518
Inline the references in the intro
mhucka File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we drop it from the docs if it is no longer maintained?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
C.f. #771