Update README with more information.

VHDL / Compliance-Tests

Tests to evaluate the support of VHDL 2008 and VHDL 2019 features

https://vhdl.github.io/Compliance-Tests/

Apache License 2.0

25 stars 7 forks source link

Update README with more information. #22

Closed bpadalino closed 1 year ago

bpadalino commented 1 year ago

Added:

Dependencies
Supported and non-supported simulators
VUnit installation instructions
Running instructions
Results interpretation explaining minimum checking

umarcor commented 1 year ago

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 commented 1 year ago

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.

bpadalino commented 1 year ago

Usage is fine with me.