diff options
| author | azidar | 2015-02-24 16:34:43 -0800 |
|---|---|---|
| committer | azidar | 2015-02-24 16:34:43 -0800 |
| commit | 787253e0d9d81b84560a8d0b6bca9d6f0253e2d9 (patch) | |
| tree | a1ee6a93b901924a8ccd5c2ec142c58040e73da1 | |
| parent | d0dddb37c056647e7fed4e9771650ef41f85bae3 (diff) | |
Trying to get README formatting correct
| -rw-r--r-- | README.md | 34 |
1 files changed, 17 insertions, 17 deletions
@@ -5,35 +5,35 @@ 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 :) -The hardest part to port will likely be the parser, but we hope to use an scala parser for the port. +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 :) +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 + `; Clone repository + git clone https://github.com/ucb-bar/firrtl + ; Stanza installation - make install + `make install + + ; Install lit (this assumes you have pip installed) + pip install lit - ; Install lit <- this assumes you have pip installed - pip install lit - ; Build firrtl - make build + make build ; Run tests - make check + make check ; Build & test - make - ` + make` + |
