Add firrtl override option and quick start example

README.md

@@ -1,17 +1,30 @@
 # barstools
 Useful utilities for BAR projects
 
-Passes/Transforms that could be useful if added here:
-* Check that a module was de-duplicated. Useful for MIM CAD flows and currently done in python.
+## Quick Start
 
-Be sure to publish-local the following repositories:
-* ucb-bar/chisel-testers (requires ucb-bar/firrtl-interpreter)
-* ucb-bar/firrtl
+Example use of how to run the GenerateTop transform:
 
-Example Usage:
 ```
 sbt
 > compile
 > project tapeout
 > run-main barstools.tapeout.transforms.GenerateTop -i <myfile>.fir -o <myfile>.v --syn-top <mysyntop> --harness-top <myharnesstop>
 ```
+
+Or as an (almost) one-liner:
+
+```
+export FIRRTL_HOME=/path/to/firrtl # path to firrtl (master)
+sbt -DFIRRTL_HOME=$FIRRTL_HOME "project tapeout" "run-main barstools.tapeout.transforms.GenerateTop -i MyModule.fir -o MyModule.v --syn-top MyModule --harness-top MyModule"
+```
+
+## TODO
+
+Passes/Transforms that could be useful if added here:
+
+* Check that a module was de-duplicated. Useful for MIM CAD flows and currently done in python.
+
+Be sure to publish-local the following repositories:
+* ucb-bar/chisel-testers (requires ucb-bar/firrtl-interpreter)
+* ucb-bar/firrtl

build.sbt

@@ -2,6 +2,11 @@
 
 import Dependencies._
 
+resolvers in ThisBuild ++= Seq(
+  Resolver.sonatypeRepo("snapshots"),
+  Resolver.sonatypeRepo("releases")
+)
+
 lazy val commonSettings = Seq(
   organization := "edu.berkeley.cs",
   version := "0.1-SNAPSHOT",
@@ -15,11 +20,15 @@ val defaultVersions = Map(
   "chisel-iotesters" -> "1.2-SNAPSHOT"
 )
 
+val firrtl_path = sys.props.getOrElse("FIRRTL_HOME", default="firrtl")
+lazy val firrtl = RootProject(file(firrtl_path))
+
 lazy val tapeout = (project in file("tapeout"))
+  .dependsOn(firrtl)
   .settings(commonSettings)
   .settings(
     libraryDependencies ++= Seq("chisel3","chisel-iotesters").map {
       dep: String => "edu.berkeley.cs" %% dep % sys.props.getOrElse(dep + "Version", defaultVersions(dep))
     }
   )
-  .settings(scalacOptions in Test ++= Seq("-language:reflectiveCalls"))
+  .settings(scalacOptions in Test ++= Seq("-language:reflectiveCalls"))