[doc] Document basic commands for running/checking Ibex
Open
Beginner friendly
Nobody has claimed this yet.
Component:Doc
Good First Issue
Type:Task
- Dominant language
- SystemVerilog
- Stars
- 2.1k
- Forks
- 810
- Avg merge
- 5d 23h
- Merged PRs (30d)
- 9
Description
We should add some documentation around how to run lint, run RISC-V verification etc. The current top-level Makefile does help here but it'd be useful for this information to be included in the main Ibex documentation set as part of the getting started information.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the top-level Makefile to identify the lint and RISC-V verification commands, then locate the main Ibex getting-started documentation. Add the relevant commands and verify that the documented instructions work as expected.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, testing-qa
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100