summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJosh Bassett2020-07-30 09:07:02 +1000
committerGitHub2020-07-29 23:07:02 +0000
commit8aeb39b9b3755ccd0e3aa600b813ed4220ac72d8 (patch)
treed7c764b8b81ee49aa2d79ef54dd2fa7ef255de1a /README.md
parenta4312eb0c054c0c782e9c61d3cdcf38de675ab75 (diff)
Update build instructions in README (#1524)
The instructions for building Chisel locally didn't include anything about firrtl or treadle. The steps are: 1. publishLocal current working copy of FIRRTL 2. publishLocal current working copy of Treadle 3. sbt test in chisel3
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index a4480cfc..ad6c5fdd 100644
--- a/README.md
+++ b/README.md
@@ -143,9 +143,20 @@ This section describes how to get started developing Chisel itself, including ho
### Compiling and Testing Chisel
-In the chisel3 repository directory compile the Chisel library:
+First, clone and build the master branch of [FIRRTL](https://github.com/freechipsproject/firrtl) and [Treadle](https://github.com/freechipsproject/treadle), as the master branch of Chisel may depend on unreleased changes in those projects:
```
+git clone https://github.com/freechipsproject/firrtl.git
+git clone https://github.com/freechipsproject/treadle.git
+pushd firrtl; sbt publishLocal; popd
+pushd treadle; sbt publishLocal; popd
+```
+
+Clone and build the Chisel library:
+
+```
+git clone https://github.com/freechipsproject/chisel3.git
+cd chisel3
sbt compile
```