[docs] First cut at recommending fud2 throughout #2498
Merged
Conversation
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
Just an attempt to convert all the low-hanging fruit I could find in the docs to refer to fud2 instead of fud. I haven't done anything about the actual fud docs themselves, the "experimental" label, or anything like that. Most of the changes are pretty mechanical. The only substantial bit of new writing is in the "getting started" guide, where I added a compressed overview of how to install fud2 (which is of course already explained in more detail on the main fud2 docs page).
| @@ -142,7 +142,7 @@ But now we're controlling things with an execution schedule. | |||
|
|
|||
| If you're curious to see how the Calyx compiler lowers this program to a Verilog-like structural form of Calyx, you can do this: | |||
|
|
|||
| fud exec language-tutorial-mem.futil --to calyx-lowered | |||
| calyx language-tutorial-mem.futil | |||
There was a problem hiding this comment.
This might be silly but just making sure, this only works if you installed the crate right?
There was a problem hiding this comment.
If you installed the executable, yes. I guess I hope that's not too much to assume…
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.
Here's a quick attempt to convert all the low-hanging fruit I could find in the docs to refer to fud2 instead of fud. I haven't done anything about the actual fud docs themselves, the "experimental" label, or anything like that.
Most of the changes are pretty mechanical. The only substantial bit of new writing is in the "getting started" guide, where I added a compressed overview of how to install fud2 (which is of course already explained in more detail on the main fud2 docs page).
I'm sure there's plenty more to do here, but I thought I'd just get the ball rolling!