Skip to content

Commit d5c7e8f

Browse files
committed
docs: Include linter requirements in README setup instructions
Added isort, black, and flake8 to Python setup steps and mentioned Verible as a dependency for RTL linting. Signed-off-by: Miguel Osorio <miguelosorio@google.com>
1 parent e051d1f commit d5c7e8f

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Files under the [tools](tools/) directory may be available under a different lic
4343
- Verilator **(4.106 or later)** must be installed on the system if running with Verilator
4444
- If adding/removing instructions, [`espresso`](https://github.com/chipsalliance/espresso/tree/master) must be installed (used by `tools/coredecode`). Remember to checkout on `3.x` branch.
4545
- RISCV tool chain (based on gcc version 8.3 or higher) must be installed so that it can be used to prepare RISCV binaries to run.
46+
- [**Verible**](https://github.com/chipsalliance/verible) is used for SystemVerilog linting and formatting.
4647
- **Python 3.10+** is required for verification, documentation, and linting.
4748

4849
### Python Environment Setup
@@ -61,7 +62,7 @@ source .venv/bin/activate
6162
pip install -r verification/top/requirements.txt \
6263
-r verification/block/requirements.txt \
6364
-r docs/requirements.txt \
64-
nox meson
65+
nox meson isort black flake8
6566
```
6667

6768
#### Using `Conda`
@@ -76,7 +77,7 @@ conda activate veer-el2
7677
pip install -r verification/top/requirements.txt \
7778
-r verification/block/requirements.txt \
7879
-r docs/requirements.txt \
79-
nox meson
80+
nox meson isort black flake8
8081
```
8182

8283
## Quickstart guide

0 commit comments

Comments
 (0)