Skip to content
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

Need to document the examples #136

Open
wirthlin opened this issue May 17, 2021 · 1 comment
Open

Need to document the examples #136

wirthlin opened this issue May 17, 2021 · 1 comment
Labels
good first issue Good for newcomers

Comments

@wirthlin
Copy link
Collaborator

There are a lot of files used for examples. It would be nice to create a simple table in a markdown file in the same directory that gives the name, a short description of what the example does, and then some sort of size parameter so we can get a feel for its complexity.

https://github.com/byuccl/spydrnet/tree/master/spydrnet/support_files/EDIF_netlists

@thunder-hammer
Copy link
Collaborator

Our Verilog examples are all based on the EDIF examples.
I think we have a script in the repository to generate the Verilog files from the EDIF examples. We can document that script and how to use it.

I'm not sure where all of the EDIF examples came from. Some of them may be that we need to open up a synthesized design and guess somewhat what they do. Others may have come from OpenCores.

Do we have some example netlists or hdl designs that are passed around the lab or on a server? perhaps some came from those if they exist.

@jacobdbrown4 jacobdbrown4 added the good first issue Good for newcomers label Apr 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
No open projects
Development

No branches or pull requests

3 participants