From 8aeb39b9b3755ccd0e3aa600b813ed4220ac72d8 Mon Sep 17 00:00:00 2001
From: Josh Bassett
Date: Thu, 30 Jul 2020 09:07:02 +1000
Subject: 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---
 README.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

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
 ```
 
-- 
cgit v1.2.3