diff options
| author | azidar | 2015-02-24 16:46:04 -0800 |
|---|---|---|
| committer | azidar | 2015-02-24 16:46:04 -0800 |
| commit | 18f21d1e2f3739c588787611ee6f5bdc195439ff (patch) | |
| tree | 2d256a9b4859c586d01b16bef4ae5e00b2aea54c | |
| parent | 53b1388c6cec41eb305af9c0b7d06be21e132f99 (diff) | |
Trying to get README formatting correct, again again again again
| -rw-r--r-- | README.md | 25 |
1 files changed, 11 insertions, 14 deletions
@@ -1,20 +1,17 @@ # firrtl -Flexible Internal Representation for RTL +## Flexible Internal Representation for RTL -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 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. - -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. +### 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 # Stanza installation` `pip install lit # Install lit (this assumes you have pip installed)` |