aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJim Lawson2016-12-13 14:12:30 -0800
committerJack Koenig2016-12-13 14:12:30 -0800
commitf6ab2b92c690b38d73886468e0e5a4c256a82dd1 (patch)
treeabe64e718970ff474a4e6c30e89c480e8e758202
parent4d5e6fc509203efc46713f6aaf1129f72d447d76 (diff)
Update installation instructions with sbt publish-local. (#393)
Also, delete run regression part of Installation since `sbt test` does that anyway
-rw-r--r--README.md13
1 files changed, 6 insertions, 7 deletions
diff --git a/README.md b/README.md
index ad726aec..a7ad0b85 100644
--- a/README.md
+++ b/README.md
@@ -21,14 +21,13 @@
##### Installation
1. Clone the repository:
```git clone https://github.com/ucb-bar/firrtl; cd firrtl```
- 2. Compile firrtl:```sbt compile```
- 3. Run tests: ```sbt test```
- 4. Build executable (`utils/bin/firrtl`): ```sbt assembly```
- * **Note:** You can add `utils/bin/firrtl` to your path to call firrtl from other processes
- 5. Run regression:
+ 1. Compile firrtl: ```sbt compile```
+ 1. Run tests: ```sbt test```
+ 1. Build executable (`utils/bin/firrtl`): ```sbt assembly```
+ * **Note:** You can add `utils/bin` to your path to call firrtl from other processes
+ 1. Publish this version locally in order to satisfy other tool chain library dependencies:
```
-mkdir -p build
-./utils/bin/firrtl -i regress/rocket.fir -o build/rocket.v -X verilog
+sbt publish-local
```
##### Useful sbt Tips