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

"vendor/" Lacks README #2451

Open
silabs-robin opened this issue May 29, 2024 · 1 comment
Open

"vendor/" Lacks README #2451

silabs-robin opened this issue May 29, 2024 · 1 comment
Assignees
Labels
Common Infrastructure Library components or scriptware common to all environments in CORE-V-VERIF documentation Improvements or additions to documentation

Comments

@silabs-robin
Copy link
Contributor

Type

  • Other.

Steps to Reproduce

cd vendor.
If you don't already know what that directory is, you won't find out in that directory.
Is it documented in a core-specific external repo?
A simple readme file with one sentence would inform either were the documentation is or explain what the directory is and how to use it.
For anyone wishing to use the content of that directory, that directory itself is the most natural place to look.

@MikeOpenHWGroup MikeOpenHWGroup added documentation Improvements or additions to documentation Common Infrastructure Library components or scriptware common to all environments in CORE-V-VERIF labels May 29, 2024
@MikeOpenHWGroup
Copy link
Member

Good point @silabs-robin! The same could be said for vendor_lib. I will work with @MarioOpenHWGroup to create a couple of helpful (?) READMEs for these directories.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Common Infrastructure Library components or scriptware common to all environments in CORE-V-VERIF documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants