docs: clarify that GHDL is a rolling project #694
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
Added a note to clarify that GHDL is a rolling project and a recommendation to use the nightly version. Closes VUnit#691
eine
reviewed
Nov 16, 2020
docs/installing.rst
Outdated
| @@ -19,7 +19,7 @@ Simulators: | |||
| - `Aldec Active-HDL`_: Tested with Active-HDL 9.3, 10.1, 10.2, 10.3 (x64/x86) | |||
| - `GHDL`_ | |||
|
|
|||
| - Works with versions >= 0.33 | |||
| - Works with versions >= 0.33 (Note: GHDL is a rolling project, it is therefore recommended to use the latest `nightly release`_ tarball.) | |||
There was a problem hiding this comment.
Please, write the URL inline:
`nightly release <https://github.com/ghdl/ghdl/releases/tag/nightly>`_Also, you can write the Note as an admonition:
- Works with versions >= 0.33
.. NOTE:: GHDL is a rolling project, it is therefore recommended to use the latest `nightly release <https://github.com/ghdl/ghdl/releases/tag/nightly>`_ tarball.There was a problem hiding this comment.
Inlined the URL, as you suggested.
eine
changed the title
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 a note to clarify that GHDL is a rolling project and a recommendation to use the nightly version. Closes #691