Update README with more information. #22
Merged
Conversation
This file contains 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
Open
Added: - Dependencies - Supported and non-supported simulators - VUnit installation instructions - Running instructions - Results interpretation explaining minimum checking
|
I believe we should put this content in the docs, rather than the readme. We can use markdown through myst-parser, so there is no need to change the syntax. I will push that to this branch. |
umarcor
added
Documentation
|
Done: https://vhdl.github.io/Compliance-Tests/Usage.html. @bpadalino is "Usage" ok or would you use a different title for the section? Note that we can have multiple sections/pages (or subsections), although I don't think it's needed yet. |
|
Usage is fine with me. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added: