You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently, readers of the Architecture Definitions documentation will find Getting Started with F4PGA Toolchain development as the first section to read. There, how to Build example and how to Load a bitstream are explained. The reason for such content to exist is probably historic (before f4pga-examples existed). However, in the context of chipsalliance/f4pga#555, it can be misleading for users (particularly those less familiar with the ecosystem).
We should move those subsections out from the Getting Started section. Getting Started should only explain how to install all the tools to run the fuzzers and to have the arch-defs assets (packages) generated. How to use those assets/packages should be not-so-easy to find in the docs of this repo:
If users are interested in those subsections only, they are probably potential users of f4pga-examples, not this repo.
Developers building the assets might want to test them, indeed. Hence, we can keep guidelines about how to run the smoke-tests available in this repo. However, we should place them under section "Development" (maybe "Testing" or "Continuous Integration").
The text was updated successfully, but these errors were encountered:
Currently, readers of the Architecture Definitions documentation will find Getting Started with F4PGA Toolchain development as the first section to read. There, how to Build example and how to Load a bitstream are explained. The reason for such content to exist is probably historic (before f4pga-examples existed). However, in the context of chipsalliance/f4pga#555, it can be misleading for users (particularly those less familiar with the ecosystem).
We should move those subsections out from the Getting Started section. Getting Started should only explain how to install all the tools to run the fuzzers and to have the arch-defs assets (packages) generated. How to use those assets/packages should be not-so-easy to find in the docs of this repo:
The text was updated successfully, but these errors were encountered: