aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJack2015-10-14 14:00:21 -0700
committerJack2015-10-14 14:00:21 -0700
commit0122af3d602608bf41df7af1703a04bb738c0531 (patch)
tree41be5375ea2aee17c392ac883963582c5e779d74 /README.md
parent9b737de6551e7446dfd92d86cd009b4b2f95c980 (diff)
Updated Makefile and README to be more friendly to Scala implementation
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index 4dc9d1b7..2c2a342e 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,9 @@
`make # Build & test`
#### Scala implementation
-The Scala FIRRTL implementation relies upon sbt.
+The Scala FIRRTL implementation relies upon sbt 0.13.6. It uses sbt-assembly to create a fat JAR.
+Using a bash script and a symbolic link it can be used with the same command-line arguments as the stanza implementation.
Example use:
- `sbt -mem 2048 "run-main Example <input> <output>`
-This command will read in &lt;input&gt; FIRRTL file, parse it, then output the AST to &lt;output&gt;
+ `make build-scala`
+ `make set-scala` # Creates symbolic link, make set-stanza reverts to stanza implementation
+ `./utils/bin/firrtl -i <input> -o <output> -X <compiler>`