diff options
| -rw-r--r-- | README.md | 42 |
1 files changed, 13 insertions, 29 deletions
@@ -6,34 +6,18 @@ Description: This repository contains the compiler for .firrtl files. It is currently being developed in stanza, with the end-goal to translate into scala for ease of other people to use. This decision was made for multiple reasons: - (1) previous development had already been done in stanza - (2) most of the passes are relatively language independent - (3) stanza is easier to develop in than scala bc less-strict type system - (4) as a favor, its useful to develop in stanza to give Patrick some language tips :) + (1) previous development had already been done in stanza + (2) most of the passes are relatively language independent + (3) stanza is easier to develop in than scala bc less-strict type system + (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 scala parser for the port. -Installation instructions: - --- Disclaimer: This project is going through development stages so there is no guarantee anything works. - --- These installations are for a mac. Won't work for a Unix-based system. - - ; Clone repository - `git clone https://github.com/ucb-bar/firrtl` - - ; Stanza installation - `make install - - ; Install lit (this assumes you have pip installed) - pip install lit - - ; Build firrtl - make build - - ; Run tests - make check - - ; Build & test - make` - - +Installation instructions: +-- Disclaimer: This project is going through development stages so there is no guarantee anything works. +-- These installations are for a mac. Won't work for a Unix-based system. + `git clone https://github.com/ucb-bar/firrtl # Clone repository` + `make install # Stanza installation` + `pip install lit # Install lit (this assumes you have pip installed)` + `make build # Build firrtl` + `make check # Run tests` + `make # Build & test` |