summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMegan Wachs2021-07-27 13:54:44 -0700
committerGitHub2021-07-27 13:54:44 -0700
commite3d245e0bfaf164996fac655b2da0818e1ad37d0 (patch)
tree7e4775baeea9c6c1dfd0a33e24df70dbdb8fe8ba
parent3c7e47633b3caed5d0e85984174405ba1591fa5b (diff)
Clarify test dependencies in README, add noplugin (#2053)
There are now more tool dependecies than just `verilator` to get the full test suite to pass. Also add instructions for running the tests without the compiler plugin,
-rw-r--r--README.md18
1 files changed, 15 insertions, 3 deletions
diff --git a/README.md b/README.md
index 1b36d91d..d5ddb0fb 100644
--- a/README.md
+++ b/README.md
@@ -172,15 +172,27 @@ cd chisel3
sbt compile
```
-In order to run the following unit tests, make sure you have Verilator installed and on your `PATH`
-(you can check this by running `which verilator`).
+In order to run the following unit tests, you will need several tools on your `PATH`, namely
+[verilator](https://www.veripool.org/verilator/),
+[yosys](http://www.clifford.at/yosys/),
+[espresso](https://github.com/chipsalliance/espresso),
+and [z3](https://github.com/Z3Prover/z3).
+Check that each is installed on your `PATH` by running `which verilator` and so on.
-If the compilation succeeded, you can then run the included unit tests by invoking:
+If the compilation succeeded and the dependencies noted above are installed, you can then run the included unit tests by invoking:
```
sbt test
```
+
+
+If you would like to run the tests without the compiler plugin (less common), you can do so by first launching `sbt`,
+then running `noPluginTests / test`:
+```
+sbt
+> noPluginTests / test
+```
### Running Projects Against Local Chisel
To use the development version of Chisel (`master` branch), you will need to build from source and `publishLocal`.