[doc] Update configurations in README.md
Nobody has claimed this yet.
- Dominant language
- SystemVerilog
- Stars
- 2.1k
- Forks
- 810
- Avg merge
- 5d 23h
- Merged PRs (30d)
- 9
Description
[The configurations in `doc/02_user/configuration.rst`] differ from [those in the ReadMe](https://github.com/lowRISC/ibex#configuration). While updating the ReadMe is probably out of scope of this PR, should we create an issue to align it?
_Originally posted by @andreaskurth in https://github.com/lowRISC/ibex/pull/1980#discussion_r1098870794_
Yes, we should. I think we can just switch to maxperf-pmp-bmbalance, though will need to get some synthesis numbers. We should add the 'micro' configuration too though I don't think that can be a supported configuration as I don't think riscv-dv supports it (I seem to remember there are some toolchain issues with E as well). Still we could do some verilator based smoke test for the micro config, ensure it's not entirely dead ;)
_Originally posted by @GregAC in https://github.com/lowRISC/ibex/pull/1980#discussion_r1102829220_
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
Compare the configuration section in README.md with doc/02_user/configuration.rst, starting with the configurations named in both files. Resolve which configurations and synthesis numbers should be documented, including whether the micro configuration needs a Verilator smoke test; done means the README and configuration guide are aligned and the stated validation is available.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100