aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorducky2016-01-16 14:11:04 -0800
committerducky2016-01-16 15:51:24 -0800
commit017c6547d38b88a2b3121b88f61dfe50cd3fa266 (patch)
tree1a11547c2cf1e36fae25559b195966b48389673e /README.md
parentf8d2ac8452e562590ad080265815cb9f3ea26bfc (diff)
Default platform-agnostic, ignore platform-specific FileCheck
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 01648fa9..cb1ef726 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,6 @@
1. Actually build firrtl:
`make build`
1. Run `make set-linux`, which links the FileCheck binary to the Linux version.
- The original binary is compiled for Mac and will not work.
* **Note**: This compiled binary may not run on all platforms. You may need to build
Clang/LLVM from source to extract the compiled FileCheck utility.
1. Add `firrtl/utils/bin` to your `PATH`, so that the compiled firrtl will be
@@ -45,6 +44,7 @@
`pip install lit`
1. Build firrtl:
`make build`
+ 1. Run `make set-osx`, which links the FileCheck binary to the Mac version.
1. Run tests:
`make check`
1. Build and test:
@@ -57,6 +57,6 @@ Example use:
1. Build the fat JAR using the makefile: `make build-scala`, or using sbt: `sbt assembly`
* For development, you can have sbt automatically monitor for changes and recompile: `sbt ~assembly`
1. Link firrtl to the Scala version: `make set-scala` (can be reverted with `make set-stanza`)
- 1. Scala firrtl can be invoked in the same way as Stanza firrtl:
+ 1. Scala firrtl can be invoked in the same way as Stanza firrtl (and the test
+ make targets should continue to work):
`./utils/bin/firrtl -i <input> -o <output> -X <compiler>`
- * As a result, the test make targets should use Scala firrtl and work properly