Linux compatibility instructions and files

2 files changed, 36 insertions, 8 deletions

diff --git a/README.md b/README.md
index e02f0e8e..8c380041 100644
--- a/README.md
+++ b/README.md
@@ -10,11 +10,39 @@
        4.   As a favor, its useful to develop in stanza to give Patrick some language tips :)   
  The hardest part to port will likely be the parser, but we hope to use an existing scala-based general-purpose parser for the port.   
 
-#### Installation instructions (for Mac):    
-*Disclaimer*: This project is going through development stages so there is no guarantee anything works.     
-    `git clone https://github.com/ucb-bar/firrtl # Clone repository`     
-    `make install-mac # Stanza installation`     
-    `pip install lit # Install lit (this assumes you have pip installed)`     
-    `make build # Build firrtl`     
-    `make check # Run tests`     
-    `make # Build & test`     
+#### Installation Instructions
+*Disclaimer*: This project is going through development stages so there is no guarantee anything works.
+
+##### For Linux:         
+ 1. Clone the repository:   
+ `git clone https://github.com/ucb-bar/firrtl`
+ 1. Install Stanza:  
+ `make install-mac`
+ 1. Install lit (you need to have pip installed first):  
+ `pip install lit`
+ 1. Build firrtl:  
+ `make build`
+ 1. Add `firrtl/utils/bin` to your `PATH`, so that the compiled firrtl will be
+ available anywhere. This also makes FileCheck available for the tests.
+ 1. Rename `FileCheck_linux` in `firrtl/utils/bin` to `FileCheck`. The original
+ `FileCheck` is a compiled Mac version and will not run on Linux.  
+ *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. Run tests:  
+ `make check`
+ 1. Build and test:  
+ `make`
+
+##### For Mac:    
+ 1. Clone the repository:   
+ `git clone https://github.com/ucb-bar/firrtl`
+ 1. Install Stanza:  
+ `make install-mac`
+ 1. Install lit (you need to have pip installed first):  
+ `pip install lit`
+ 1. Build firrtl:  
+ `make build`   
+ 1. Run tests:  
+ `make check`
+ 1. Build and test:  
+ `make`
diff --git a/utils/bin/FileCheck_linux b/utils/bin/FileCheck_linux
new file mode 100755
index 00000000..1bb70b6d
--- /dev/null
+++ b/utils/bin/FileCheck_linux